preferences

Vars
alt_job_titles	Alternative job titles stored in preferences. Assoc list, ie. alt_job_titles["Scientist"] = "Cytologist"
character_data	The savefile relating to character preferences, PREFERENCE_CHARACTER
character_preview_view	A preview of the current character
current_window	The current window, PREFERENCE_TAB_* in [`code/__DEFINES/preferences.dm`]
default_slot	Ensures that we always load the last used save, QOL
favorite_outfits	What outfit typepaths we've favorited in the SelectEquipment menu
hearted	Someone thought we were nice! We get a little heart in OOC until we join the server past the below time (we can keep it until the end of the round otherwise)
hearted_until	If we have a hearted commendations, we honor it every time the player loads preferences until this time has been passed
key_bindings	Custom keybindings. Map of keybind names to keyboard inputs. For example, by default would have "swap_hands" -> list("X")
key_bindings_by_key	Cached list of keybindings, mapping keys to actions. For example, by default would have "X" -> list("swap_hands")
last_id	Last CID that this client has connected from
last_ip	Last IP that this client has connected from
lastchangelog	Cached changelog size, to detect new changelogs since last join
load_and_save	Whether or not we allow saving/loading. Used for guests, if they're enabled
loadout_show_equipped	Used by the loadout UI
max_save_slots	The maximum number of slots we're allowed to contain
middleware	A list of instantiated middleware
muted	Bitflags for communications that are muted
preview_pref	Preference of how the preview should show the character.
recently_updated_keys	A list of keys that have been updated since the last save.
savefile	The json savefile for this datum
selected_category	Stores the instance of the category we are viewing. (CHARACTER CREATOR)
tainted_character_profiles	If set to TRUE, will update character_profiles on the next ui_data tick.
value_cache	A cache of preference entries to values. Used to avoid expensive READ_FILE every time a preference is retrieved.
Procs
apply_all_client_preferences	Applies all PREFERENCE_PLAYER preferences
apply_prefs_to	Applies the given preferences to a human mob.
check_keybindings	checks through keybindings for outdated unbound keys and updates them
early_update_character	Called when reading preferences if a savefile update is detected. This proc is for directly tampering with preference datum values before they are sanitized by deserialize()
get_highest_priority_job	Returns what job is marked as highest
get_key_bindings_by_key	Inverts the key_bindings list such that it can be used for key_bindings_by_key
randomise_appearance_prefs	Fully randomizes everything in the character.
read_preference	Read a /datum/preference type and return its value. This will write to the savefile if a value was not found with the new value.
reset_loadout	Resets current loadout slot
safe_transfer_prefs_to	Sanitizes the preferences, applies the randomization prefs, and then applies the preference to the human mob.
update_preference	Will perform an update on the preference, but not write to the savefile. This will, for instance, update the character preference view. Performs sanity checks.
write_preference	Set a /datum/preference entry. Returns TRUE for a successful preference application. Returns FALSE if it is invalid.

Var Details

var
alt_job_titles
– /list

Alternative job titles stored in preferences. Assoc list, ie. alt_job_titles["Scientist"] = "Cytologist"

var
character_data
– /list

The savefile relating to character preferences, PREFERENCE_CHARACTER

var
character_preview_view
– /atom/movable/screen/character_preview_view

A preview of the current character

var
current_window
–

The current window, PREFERENCE_TAB_* in [code/__DEFINES/preferences.dm]

var
default_slot
–

Ensures that we always load the last used save, QOL

var
favorite_outfits
– /list

What outfit typepaths we've favorited in the SelectEquipment menu

var
hearted
–

Someone thought we were nice! We get a little heart in OOC until we join the server past the below time (we can keep it until the end of the round otherwise)

var
hearted_until
–

If we have a hearted commendations, we honor it every time the player loads preferences until this time has been passed

var
key_bindings
– /list

Custom keybindings. Map of keybind names to keyboard inputs. For example, by default would have "swap_hands" -> list("X")

var
key_bindings_by_key
– /list

Cached list of keybindings, mapping keys to actions. For example, by default would have "X" -> list("swap_hands")

var
last_id
–

Last CID that this client has connected from

var
last_ip
–

Last IP that this client has connected from

var
lastchangelog
–

Cached changelog size, to detect new changelogs since last join

var
load_and_save
–

Whether or not we allow saving/loading. Used for guests, if they're enabled

var
loadout_show_equipped
– /tmp

Used by the loadout UI

var
max_save_slots
–

The maximum number of slots we're allowed to contain

var
middleware
– /list/datum/preference_middleware

A list of instantiated middleware

var
muted
–

Bitflags for communications that are muted

var
preview_pref
– /tmp

Preference of how the preview should show the character.

var
recently_updated_keys
– /list

A list of keys that have been updated since the last save.

var
savefile
– /datum/json_savefile

The json savefile for this datum

var
selected_category
– /tmp/datum/preference_group/category

Stores the instance of the category we are viewing. (CHARACTER CREATOR)

var
tainted_character_profiles
–

If set to TRUE, will update character_profiles on the next ui_data tick.

var
value_cache
–

A cache of preference entries to values. Used to avoid expensive READ_FILE every time a preference is retrieved.

Proc Details

proc
apply_all_client_preferences
()

Applies all PREFERENCE_PLAYER preferences

proc
apply_prefs_to
(/mob/living/carbon/human/character, icon_updates)

Applies the given preferences to a human mob.

proc
check_keybindings
()

checks through keybindings for outdated unbound keys and updates them

proc
early_update_character
(current_version, /list/save_data)

Called when reading preferences if a savefile update is detected. This proc is for directly tampering with preference datum values before they are sanitized by deserialize()

proc
get_highest_priority_job
()

Returns what job is marked as highest

proc
get_key_bindings_by_key
(/list/key_bindings)

Inverts the key_bindings list such that it can be used for key_bindings_by_key

proc
randomise_appearance_prefs
(randomize_flags)

Fully randomizes everything in the character.

proc
read_preference
(preference_type)

Read a /datum/preference type and return its value. This will write to the savefile if a value was not found with the new value.

proc
reset_loadout
()

Resets current loadout slot

proc
safe_transfer_prefs_to
(/mob/living/carbon/human/character, icon_updates, is_antag)

Sanitizes the preferences, applies the randomization prefs, and then applies the preference to the human mob.

proc
update_preference
(/datum/preference/preference, preference_value)

Will perform an update on the preference, but not write to the savefile. This will, for instance, update the character preference view. Performs sanity checks.

proc
write_preference
(/datum/preference/preference, preference_value)

Set a /datum/preference entry. Returns TRUE for a successful preference application. Returns FALSE if it is invalid.

preferences /datum/preferences

Vars

Procs

Var Details

var alt_job_titles – /list

var character_data – /list

var character_preview_view – /atom/movable/screen/character_preview_view

var current_window –

var default_slot –

var favorite_outfits – /list

var hearted –

var hearted_until –

var key_bindings – /list

var key_bindings_by_key – /list

var last_id –

var last_ip –

var lastchangelog –

var load_and_save –

var loadout_show_equipped – /tmp

var max_save_slots –

var middleware – /list/datum/preference_middleware

var muted –

var preview_pref – /tmp

var recently_updated_keys – /list

var savefile – /datum/json_savefile

var selected_category – /tmp/datum/preference_group/category

var tainted_character_profiles –

var value_cache –