preference_middleware

Preference middleware is code that helps to decentralize complicated preference features.

Vars
action_delegations	Map of ui_act actions -> proc paths to call. Signature is `(list/params, mob/user) -> TRUE/FALSE. Return output is the same as ui_act--TRUE if it should update, FALSE if it should not
key	The key that will be used for get_constant_data(). If null, will use the typepath minus /datum/preference_middleware.
preferences	The preferences datum
Procs
add_preview_answer	Adds what this middleware reads from the preview mob to an answer, which goes to the page right after the mob is rebuilt for the changes the answer covers (start_answer()). The window's own data, sent as each change is made, may read the mob before it is rebuilt. Add only what changed since the page last got it.
apply_to_human	Called when applying preferences to the mob.
get_character_preferences	Merge this into the result of compile_character_preferences.
get_constant_data	Append all of these into /datum/asset/json/preferences.
get_ui_assets	Append all of these into ui_assets
get_ui_data	Append all of these into ui_data
get_ui_static_data	Append all of these into ui_static_data
on_new_character	Called when a character is changed.
post_set_preference	Called after every update_preference
pre_set_preference	Called before every update_preference, returns TRUE if this handled it.

Var Details

var
action_delegations
– /list

Map of ui_act actions -> proc paths to call. Signature is `(list/params, mob/user) -> TRUE/FALSE. Return output is the same as ui_act--TRUE if it should update, FALSE if it should not

var
key

The key that will be used for get_constant_data(). If null, will use the typepath minus /datum/preference_middleware.

var
preferences
– /datum/preferences

The preferences datum

Proc Details

proc
add_preview_answer
(/list/update)

Adds what this middleware reads from the preview mob to an answer, which goes to the page right after the mob is rebuilt for the changes the answer covers (start_answer()). The window's own data, sent as each change is made, may read the mob before it is rebuilt. Add only what changed since the page last got it.

Arguments:

update: The keys the answer sends the page. Changed in place.

proc
apply_to_human
(/mob/living/carbon/human/target, /datum/preferences/preferences, visuals_only)

Called when applying preferences to the mob.

proc
get_character_preferences
(/mob/user)

Merge this into the result of compile_character_preferences.

proc
get_constant_data
()

Append all of these into /datum/asset/json/preferences.

proc
get_ui_assets
()

Append all of these into ui_assets

proc
get_ui_data
(/mob/user)

Append all of these into ui_data

proc
get_ui_static_data
(/mob/user)

Append all of these into ui_static_data

proc
on_new_character
(/mob/user)

Called when a character is changed.

proc
post_set_preference
(/mob/user, preference, value)

Called after every update_preference

proc
pre_set_preference
(/mob/user, preference, value)

Called before every update_preference, returns TRUE if this handled it.

preference_middleware /datum/preference_middleware

Vars

Procs

Var Details

var action_delegations – /list

var key

var preferences – /datum/preferences

Proc Details

proc add_preview_answer(/list/update)

proc apply_to_human(/mob/living/carbon/human/target, /datum/preferences/preferences, visuals_only)

proc get_character_preferences(/mob/user)

proc get_constant_data()

proc get_ui_assets()

proc get_ui_data(/mob/user)

proc get_ui_static_data(/mob/user)

proc on_new_character(/mob/user)

proc post_set_preference(/mob/user, preference, value)

proc pre_set_preference(/mob/user, preference, value)