Space Station 13 - Modules - TypesVar Details - Proc Details

preferences

Vars

_2fa_status2FA status
active_characterThe current active character
admin_sound_ckey_ignoreList of admin ckeys this player wont hear sounds from
character_savesList of all character saves we have. This is indexed based on the slot number
characters_loadedHave we loaded characters already?
colourblind_modeColourblind mode
ghost_darkness_levelHow dark things are if client is a ghost, 0-255
keybindingsActive keybinds (currently useable by the mob/client)
keybindings_overridesKeybinding overrides ("name" => ["key"...])
screentip_colorColor of screentips at top of screen
screentip_modeScreentip Mode, in pixels. 8 is small, 15 is mega big, 0 is off.
server_regionPlayer's region override for routing optimisation
successful_loadDid we load successfully?
viewrangeView range preference for this client
volume_mixerVolume mixer, indexed by channel as TEXT (numerical indexes will not work). Volume goes from 0 to 100.
volume_mixer_savingThe volume mixer save timer handle. Used to debounce the DB call to save, to avoid spamming.

Procs

build_loadoutRebuilds the loadout_gear list of the [active_character], and returns the total end cost.
deserialize_volume_mixerReturns a volume mixer list from text, usually from the DB.
get_channel_volumeReturns a volume multiplier for the given channel, from 0 to 1 (default).
save_volume_mixerSaves [/datum/preferences/proc/volume_mixer] for the current client.
serialize_volume_mixerReturns a DB-friendly version of a volume mixer list.
set_channel_volumeChanges a channel's volume then queues it for DB save.

Var Details

_2fa_status

2FA status

active_character

The current active character

admin_sound_ckey_ignore

List of admin ckeys this player wont hear sounds from

character_saves

List of all character saves we have. This is indexed based on the slot number

characters_loaded

Have we loaded characters already?

colourblind_mode

Colourblind mode

ghost_darkness_level

How dark things are if client is a ghost, 0-255

keybindings

Active keybinds (currently useable by the mob/client)

keybindings_overrides

Keybinding overrides ("name" => ["key"...])

screentip_color

Color of screentips at top of screen

screentip_mode

Screentip Mode, in pixels. 8 is small, 15 is mega big, 0 is off.

server_region

Player's region override for routing optimisation

successful_load

Did we load successfully?

viewrange

View range preference for this client

volume_mixer

Volume mixer, indexed by channel as TEXT (numerical indexes will not work). Volume goes from 0 to 100.

volume_mixer_saving

The volume mixer save timer handle. Used to debounce the DB call to save, to avoid spamming.

Proc Details

build_loadout

Rebuilds the loadout_gear list of the [active_character], and returns the total end cost.

Caches and cuts the existing [/datum/character_save/var/loadout_gear] list and remakes it, checking the subtype_selection_cost and overall cost validity of each item.

If the item's /datum/gear/var/subtype_selection_cost is FALSE, any future items with the same /datum/gear/var/main_typepath will have their cost skipped. If adding the item will take the total cost over the maximum, it won't be added to the list.

Arguments:

deserialize_volume_mixer

Returns a volume mixer list from text, usually from the DB.

Failure to deserialize will return the current value.

Arguments

get_channel_volume

Returns a volume multiplier for the given channel, from 0 to 1 (default).

Arguments:

save_volume_mixer

Saves [/datum/preferences/proc/volume_mixer] for the current client.

serialize_volume_mixer

Returns a DB-friendly version of a volume mixer list.

Arguments

set_channel_volume

Changes a channel's volume then queues it for DB save.

Arguments: