GLOBAL_LIST_EMPTY(preferences_datums) /datum/preferences var/client/parent //doohickeys for savefiles var/path var/default_slot = 1 //Holder so it doesn't default to slot 1, rather the last one used var/max_save_slots = 3 //non-preference stuff var/muted = 0 var/last_ip var/last_id //game-preferences var/lastchangelog = "" //Saved changlog filesize to detect if there was a change //Antag preferences var/list/be_special = list() //Special role selection /// Custom keybindings. Map of keybind names to keyboard inputs. /// For example, by default would have "swap_hands" -> list("X") var/list/key_bindings = list() /// Cached list of keybindings, mapping keys to actions. /// For example, by default would have "X" -> list("swap_hands") var/list/key_bindings_by_key = list() var/toggles = TOGGLES_DEFAULT var/db_flags var/chat_toggles = TOGGLES_DEFAULT_CHAT var/ghost_form = "ghost" //character preferences var/slot_randomized //keeps track of round-to-round randomization of the character slot, prevents overwriting var/list/randomise = list() //Quirk list var/list/all_quirks = list() //Job preferences 2.0 - indexed by job title , no key or value implies never var/list/job_preferences = list() /// The current window, PREFERENCE_TAB_* in [`code/__DEFINES/preferences.dm`] var/current_window = PREFERENCE_TAB_CHARACTER_PREFERENCES var/unlock_content = 0 var/list/ignoring = list() var/list/exp = list() var/action_buttons_screen_locs = list() ///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 ///If we have a hearted commendations, we honor it every time the player loads preferences until this time has been passed var/hearted_until /// If we have persistent scars enabled var/persistent_scars = TRUE ///What outfit typepaths we've favorited in the SelectEquipment menu var/list/favorite_outfits = list() /// A preview of the current character var/atom/movable/screen/character_preview_view/character_preview_view /// A list of instantiated middleware var/list/datum/preference_middleware/middleware = list() /// The savefile relating to core preferences, PREFERENCE_PLAYER var/savefile/game_savefile /// The savefile relating to character preferences, PREFERENCE_CHARACTER var/savefile/character_savefile /// A list of keys that have been updated since the last save. var/list/recently_updated_keys = list() /// A cache of preference entries to values. /// Used to avoid expensive READ_FILE every time a preference is retrieved. var/value_cache = list() /// If set to TRUE, will update character_profiles on the next ui_data tick. var/tainted_character_profiles = FALSE /datum/preferences/Destroy(force, ...) QDEL_NULL(character_preview_view) QDEL_LIST(middleware) value_cache = null return ..() /datum/preferences/New(client/C) parent = C for (var/middleware_type in subtypesof(/datum/preference_middleware)) middleware += new middleware_type(src) if(istype(C)) if(!is_guest_key(C.key)) load_path(C.ckey) unlock_content = !!C.IsByondMember() if(unlock_content) max_save_slots = 8 // give them default keybinds and update their movement keys key_bindings = deep_copy_list(GLOB.default_hotkeys) key_bindings_by_key = get_key_bindings_by_key(key_bindings) randomise = get_default_randomization() var/loaded_preferences_successfully = load_preferences() if(loaded_preferences_successfully) if(load_character()) return //we couldn't load character data so just randomize the character appearance + name randomise_appearance_prefs() //let's create a random character then - rather than a fat, bald and naked man. if(C) apply_all_client_preferences() C.set_macros() if(!loaded_preferences_successfully) save_preferences() save_character() //let's save this new random character so it doesn't keep generating new ones. /datum/preferences/ui_interact(mob/user, datum/tgui/ui) // If you leave and come back, re-register the character preview if (!isnull(character_preview_view) && !(character_preview_view in user.client?.screen)) user.client?.register_map_obj(character_preview_view) ui = SStgui.try_update_ui(user, src, ui) if(!ui) ui = new(user, src, "PreferencesMenu") ui.set_autoupdate(FALSE) ui.open() // HACK: Without this the character starts out really tiny because of some BYOND bug. // You can fix it by changing a preference, so let's just forcably update the body to emulate this. addtimer(CALLBACK(character_preview_view, /atom/movable/screen/character_preview_view/proc/update_body), 1 SECONDS) /datum/preferences/ui_state(mob/user) return GLOB.always_state // Without this, a hacker would be able to edit other people's preferences if // they had the ref to Topic to. /datum/preferences/ui_status(mob/user, datum/ui_state/state) return user.client == parent ? UI_INTERACTIVE : UI_CLOSE /datum/preferences/ui_data(mob/user) var/list/data = list() if (isnull(character_preview_view)) character_preview_view = create_character_preview_view(user) else if (character_preview_view.client != parent) // The client re-logged, and doing this when they log back in doesn't seem to properly // carry emissives. character_preview_view.register_to_client(parent) if (tainted_character_profiles) data["character_profiles"] = create_character_profiles() tainted_character_profiles = FALSE data["character_preferences"] = compile_character_preferences(user) data["active_slot"] = default_slot for (var/datum/preference_middleware/preference_middleware as anything in middleware) data += preference_middleware.get_ui_data(user) return data /datum/preferences/ui_static_data(mob/user) var/list/data = list() data["character_profiles"] = create_character_profiles() data["character_preview_view"] = character_preview_view.assigned_map data["overflow_role"] = SSjob.GetJobType(SSjob.overflow_role).title data["window"] = current_window data["content_unlocked"] = unlock_content for (var/datum/preference_middleware/preference_middleware as anything in middleware) data += preference_middleware.get_ui_static_data(user) return data /datum/preferences/ui_assets(mob/user) var/list/assets = list( get_asset_datum(/datum/asset/spritesheet/preferences), get_asset_datum(/datum/asset/json/preferences), ) for (var/datum/preference_middleware/preference_middleware as anything in middleware) assets += preference_middleware.get_ui_assets() return assets /datum/preferences/ui_act(action, list/params, datum/tgui/ui, datum/ui_state/state) . = ..() if (.) return switch (action) if ("change_slot") // Save existing character save_character() // SAFETY: `load_character` performs sanitization the slot number if (!load_character(params["slot"])) tainted_character_profiles = TRUE randomise_appearance_prefs() save_character() for (var/datum/preference_middleware/preference_middleware as anything in middleware) preference_middleware.on_new_character(usr) character_preview_view.update_body() return TRUE if ("rotate") character_preview_view.dir = turn(character_preview_view.dir, -90) return TRUE if ("set_preference") var/requested_preference_key = params["preference"] var/value = params["value"] for (var/datum/preference_middleware/preference_middleware as anything in middleware) if (preference_middleware.pre_set_preference(usr, requested_preference_key, value)) return TRUE var/datum/preference/requested_preference = GLOB.preference_entries_by_key[requested_preference_key] if (isnull(requested_preference)) return FALSE // SAFETY: `update_preference` performs validation checks if (!update_preference(requested_preference, value)) return FALSE if (istype(requested_preference, /datum/preference/name)) tainted_character_profiles = TRUE return TRUE if ("set_color_preference") var/requested_preference_key = params["preference"] var/datum/preference/requested_preference = GLOB.preference_entries_by_key[requested_preference_key] if (isnull(requested_preference)) return FALSE if (!istype(requested_preference, /datum/preference/color) \ && !istype(requested_preference, /datum/preference/color_legacy) \ ) return FALSE var/default_value = read_preference(requested_preference.type) if (istype(requested_preference, /datum/preference/color_legacy)) default_value = expand_three_digit_color(default_value) // Yielding var/new_color = input( usr, "Select new color", null, default_value || COLOR_WHITE, ) as color | null if (!new_color) return FALSE if (!update_preference(requested_preference, new_color)) return FALSE return TRUE for (var/datum/preference_middleware/preference_middleware as anything in middleware) var/delegation = preference_middleware.action_delegations[action] if (!isnull(delegation)) return call(preference_middleware, delegation)(params, usr) return FALSE /datum/preferences/ui_close(mob/user) save_character() save_preferences() QDEL_NULL(character_preview_view) /datum/preferences/Topic(href, list/href_list) . = ..() if (.) return if (href_list["open_keybindings"]) current_window = PREFERENCE_TAB_KEYBINDINGS update_static_data(usr) ui_interact(usr) return TRUE /datum/preferences/proc/create_character_preview_view(mob/user) character_preview_view = new(null, src, user.client) character_preview_view.update_body() character_preview_view.register_to_client(user.client) return character_preview_view /datum/preferences/proc/compile_character_preferences(mob/user) var/list/preferences = list() for (var/datum/preference/preference as anything in get_preferences_in_priority_order()) if (!preference.is_accessible(src)) continue LAZYINITLIST(preferences[preference.category]) var/value = read_preference(preference.type) var/data = preference.compile_ui_data(user, value) preferences[preference.category][preference.savefile_key] = data for (var/datum/preference_middleware/preference_middleware as anything in middleware) var/list/append_character_preferences = preference_middleware.get_character_preferences(user) if (isnull(append_character_preferences)) continue for (var/category in append_character_preferences) if (category in preferences) preferences[category] += append_character_preferences[category] else preferences[category] = append_character_preferences[category] return preferences /// Applies all PREFERENCE_PLAYER preferences /datum/preferences/proc/apply_all_client_preferences() for (var/datum/preference/preference as anything in get_preferences_in_priority_order()) if (preference.savefile_identifier != PREFERENCE_PLAYER) continue value_cache -= preference.type preference.apply_to_client(parent, read_preference(preference.type)) // This is necessary because you can open the set preferences menu before // the atoms SS is done loading. INITIALIZE_IMMEDIATE(/atom/movable/screen/character_preview_view) /// A preview of a character for use in the preferences menu /atom/movable/screen/character_preview_view name = "character_preview" del_on_map_removal = FALSE layer = GAME_PLANE plane = GAME_PLANE /// The body that is displayed var/mob/living/carbon/human/dummy/body /// The preferences this refers to var/datum/preferences/preferences var/list/plane_masters = list() /// The client that is watching this view var/client/client /atom/movable/screen/character_preview_view/Initialize(mapload, datum/preferences/preferences, client/client) . = ..() assigned_map = "character_preview_[REF(src)]" set_position(1, 1) src.preferences = preferences /atom/movable/screen/character_preview_view/Destroy() QDEL_NULL(body) for (var/plane_master in plane_masters) client?.screen -= plane_master qdel(plane_master) client?.clear_map(assigned_map) preferences?.character_preview_view = null client = null plane_masters = null preferences = null return ..() /// Updates the currently displayed body /atom/movable/screen/character_preview_view/proc/update_body() if (isnull(body)) create_body() else body.wipe_state() appearance = preferences.render_new_preview_appearance(body) /atom/movable/screen/character_preview_view/proc/create_body() QDEL_NULL(body) body = new // Without this, it doesn't show up in the menu body.appearance_flags &= ~KEEP_TOGETHER /// Registers the relevant map objects to a client /atom/movable/screen/character_preview_view/proc/register_to_client(client/client) QDEL_LIST(plane_masters) src.client = client if (!client) return for (var/plane_master_type in subtypesof(/atom/movable/screen/plane_master) - /atom/movable/screen/plane_master/blackness) var/atom/movable/screen/plane_master/plane_master = new plane_master_type() plane_master.screen_loc = "[assigned_map]:CENTER" client?.screen |= plane_master plane_masters += plane_master client?.register_map_obj(src) /datum/preferences/proc/create_character_profiles() var/list/profiles = list() var/savefile/savefile = new(path) for (var/index in 1 to max_save_slots) // It won't be updated in the savefile yet, so just read the name directly if (index == default_slot) profiles += read_preference(/datum/preference/name/real_name) continue savefile.cd = "/character[index]" var/name READ_FILE(savefile["real_name"], name) if (isnull(name)) profiles += null continue profiles += name return profiles /datum/preferences/proc/set_job_preference_level(datum/job/job, level) if (!job) return FALSE if (level == JP_HIGH) for(var/other_job in job_preferences) if(job_preferences[other_job] == JP_HIGH) job_preferences[other_job] = JP_MEDIUM job_preferences[job.title] = level return TRUE /datum/preferences/proc/GetQuirkBalance() var/bal = 0 for(var/V in all_quirks) var/datum/quirk/T = SSquirks.quirks[V] bal -= initial(T.value) return bal /datum/preferences/proc/GetPositiveQuirkCount() . = 0 for(var/q in all_quirks) if(SSquirks.quirk_points[q] > 0) .++ /datum/preferences/proc/validate_quirks() if(GetQuirkBalance() < 0) all_quirks = list() /// Sanitizes the preferences, applies the randomization prefs, and then applies the preference to the human mob. /datum/preferences/proc/safe_transfer_prefs_to(mob/living/carbon/human/character, icon_updates = TRUE, is_antag = FALSE) apply_character_randomization_prefs(is_antag) apply_prefs_to(character, icon_updates) /// Applies the given preferences to a human mob. /datum/preferences/proc/apply_prefs_to(mob/living/carbon/human/character, icon_updates = TRUE) character.dna.features = list() for (var/datum/preference/preference as anything in get_preferences_in_priority_order()) if (preference.savefile_identifier != PREFERENCE_CHARACTER) continue preference.apply_to_human(character, read_preference(preference.type)) character.dna.real_name = character.real_name if(icon_updates) character.update_body() character.update_hair() character.update_body_parts() /// Returns whether the parent mob should have the random hardcore settings enabled. Assumes it has a mind. /datum/preferences/proc/should_be_random_hardcore(datum/job/job, datum/mind/mind) if(!read_preference(/datum/preference/toggle/random_hardcore)) return FALSE if(job.departments_bitflags & DEPARTMENT_BITFLAG_COMMAND) //No command staff return FALSE for(var/datum/antagonist/antag as anything in mind.antag_datums) if(antag.get_team()) //No team antags return FALSE return TRUE /// Inverts the key_bindings list such that it can be used for key_bindings_by_key /datum/preferences/proc/get_key_bindings_by_key(list/key_bindings) var/list/output = list() for (var/action in key_bindings) for (var/key in key_bindings[action]) LAZYADD(output[key], action) return output /// Returns the default `randomise` variable ouptut /datum/preferences/proc/get_default_randomization() var/list/default_randomization = list() for (var/preference_key in GLOB.preference_entries_by_key) var/datum/preference/preference = GLOB.preference_entries_by_key[preference_key] if (preference.is_randomizable() && preference.randomize_by_default) default_randomization[preference_key] = RANDOM_ENABLED return default_randomization