preferences

Vars
_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
fuid	Forum userid
ghost_darkness_level	How dark things are if client is a ghost, 0-255
glowlevel	Glow level for the lighting. Takes values from GLOW_HIGH to GLOW_DISABLE.
keybindings	Active keybinds (currently useable by the mob/client)
keybindings_overrides	Keybinding overrides ("name" => ["key"...])
map_vote_pref_json	Map preferences for the first past the post system
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.
Procs
build_loadout	Rebuilds the `loadout_gear` list of the [active_character], and returns the total end cost.
deserialize_volume_mixer	Returns a volume mixer list from text, usually from the DB.
get_channel_volume	Returns a volume multiplier for the given channel, from 0 to 1 (default).
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.
set_channel_volume	Changes a channel's volume then queues it for DB save.

Var Details

var
_2fa_status
–

2FA status

var
active_character
– /datum/character_save

The current active character

var
admin_sound_ckey_ignore
– /list

List of admin ckeys this player wont hear sounds from

var
character_saves
– /list/datum/character_save

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

var
characters_loaded
–

Have we loaded characters already?

var
colourblind_mode
–

Colourblind mode

var
fuid
–

Forum userid

var
ghost_darkness_level
–

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

var
glowlevel
–

Glow level for the lighting. Takes values from GLOW_HIGH to GLOW_DISABLE.

var
keybindings
– /list/datum

Active keybinds (currently useable by the mob/client)

var
keybindings_overrides
– /list

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

var
map_vote_pref_json
– /list

Map preferences for the first past the post system

var
screentip_color
–

Color of screentips at top of screen

var
screentip_mode
–

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

var
server_region
–

Player's region override for routing optimisation

var
successful_load
–

Did we load successfully?

var
viewrange
–

View range preference for this client

var
volume_mixer
– /list

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

var
volume_mixer_saving
–

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

Proc Details

proc
build_loadout
(/datum/gear/new_item)

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:

new_item - A new /datum/gear item to be added to the loadout_gear list.

proc
deserialize_volume_mixer
(vmt)

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

Failure to deserialize will return the current value.

Arguments

vmt - The volume mixer list to deserialize.

proc
get_channel_volume
(channel)

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

Arguments:

channel - The channel whose volume to get.

proc
save_volume_mixer
()

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

proc
serialize_volume_mixer
(/list/vm)

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

Arguments

vm - The volume mixer list to serialize.

proc
set_channel_volume
(channel, volume, debounce_save)

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

Arguments:

channel - The channel whose volume to change.
volume - The new volume, clamped between 0 and 100.
debounce_save - Whether to debounce the save call to prevent spamming of DB calls.

preferences /datum/preferences

Vars

Procs

Var Details

var _2fa_status –

var active_character – /datum/character_save

var admin_sound_ckey_ignore – /list

var character_saves – /list/datum/character_save

var characters_loaded –

var colourblind_mode –

var fuid –

var ghost_darkness_level –

var glowlevel –

var keybindings – /list/datum

var keybindings_overrides – /list

var map_vote_pref_json – /list

var screentip_color –

var screentip_mode –

var server_region –

var successful_load –

var viewrange –

var volume_mixer – /list

var volume_mixer_saving –

Proc Details

proc build_loadout(/datum/gear/new_item)

proc deserialize_volume_mixer(vmt)

proc get_channel_volume(channel)

proc save_volume_mixer()

proc serialize_volume_mixer(/list/vm)

proc set_channel_volume(channel, volume, debounce_save)

preferences
/datum/preferences

var
_2fa_status
–

var
active_character
– /datum/character_save

var
admin_sound_ckey_ignore
– /list

var
character_saves
– /list/datum/character_save

var
characters_loaded
–

var
colourblind_mode
–

var
fuid
–

var
ghost_darkness_level
–

var
glowlevel
–

var
keybindings
– /list/datum

var
keybindings_overrides
– /list

var
map_vote_pref_json
– /list

var
screentip_color
–

var
screentip_mode
–

var
server_region
–

var
successful_load
–

var
viewrange
–

var
volume_mixer
– /list

var
volume_mixer_saving
–

proc
build_loadout
(/datum/gear/new_item)

proc
deserialize_volume_mixer
(vmt)

proc
get_channel_volume
(channel)

proc
save_volume_mixer
()

proc
serialize_volume_mixer
(/list/vm)

proc
set_channel_volume
(channel, volume, debounce_save)