Files
Bubberstation/code/modules/admin/greyscale_modify_menu.dm
SkyratBot 306b828631 [MIRROR] Polishing the greyscale modify menu's lackluster support for non-atom targets. [MDB IGNORE] (#22965)
* Polishing the greyscale modify menu's lackluster support for non-atom targets. (#77322)

## About The Pull Request

So, I've been recently told that Skyrat uses the greyscale modify menu
for loadouts, and the new ui state kinda borked it. I honestly haven't
taken the possibility that the target could be anything but a subtype of
`/atom` (and still work) into account because much of the code assumes
the target is an atom. It's kinda crappy. Also I hadn't noticed we've an
`unlocked` variable, which makes `vv_mode` var superflous, so i'm going
to remove the latter.

* Polishing the greyscale modify menu's lackluster support for non-atom targets.

* I hope I won't have to get back and edit out the ability to modify the alpha on clothes for this

---------

Co-authored-by: Ghom <42542238+Ghommie@users.noreply.github.com>
Co-authored-by: GoldenAlpharex <jerego1234@hotmail.com>
2023-08-11 14:42:44 -04:00

357 lines
12 KiB
Plaintext

/// The controller for the ui in charge of all runtime greyscale configuration/debug.
/// If `Unlock()` is not called the menu is safe for players to use.
/datum/greyscale_modify_menu
/// The "owner" object of this menu, is usually the greyscale object being edited but that can be changed for specific uses of this menu
var/datum/target
/// The client that opened this menu
var/client/user
/// A keyed list of allowed configs in the form niceName:typepath
var/list/allowed_configs
/// A callback to control what happens when the user presses apply. Used mainly for if you want the menu to be used outside of vv.
var/datum/callback/apply_callback
/// The current config being previewed
var/datum/greyscale_config/config
/// A list of colors currently selected
var/list/split_colors
/// The type that the configuration file was assigned at
var/config_owner_type
/// Collection of data for tgui to use in displaying everything
var/list/sprite_data
/// The sprite dir currently being shown
var/sprite_dir = SOUTH
/// The sprite icon state currently being shown
var/icon_state
/// Whether the full preview should be generated, with this FALSE only the final sprite is shown instead of all steps.
var/generate_full_preview = FALSE
/// Whether the menu is in the middle of refreshing the preview
var/refreshing = TRUE
/**
* Whether the menu is currently locked down to prevent abuse from players.
* Currently is only unlocked when opened from vv.
* It also enables the user to modify the alpha channel of the colors.
*/
var/unlocked = FALSE
/datum/greyscale_modify_menu/New(datum/target, client/user, list/allowed_configs, datum/callback/apply_callback, starting_icon_state = "", starting_config, starting_colors, unlocked = FALSE)
src.target = target
var/atom/atom_target
if(isatom(target))
atom_target = target
src.user = user
src.apply_callback = apply_callback
if(!apply_callback)
if(atom_target)
src.apply_callback = CALLBACK(src, PROC_REF(DefaultApply))
else
stack_trace("A geyscale modify menu was instantiated with a non-atom target and no specified apply callback (DefaultApply won't do).")
icon_state = starting_icon_state
SetupConfigOwner()
var/current_config = "[starting_config]" || "[atom_target?.greyscale_config]"
var/datum/greyscale_config/new_config = SSgreyscale.configurations[current_config]
if(!(current_config in allowed_configs))
new_config = SSgreyscale.configurations["[allowed_configs[pick(allowed_configs)]]"]
change_config(new_config)
if(unlocked)
Unlock()
else
var/list/config_choices = list()
for(var/config_string in allowed_configs)
var/datum/greyscale_config/allowed_config = text2path("[config_string]")
config_choices[initial(allowed_config.name)] = config_string
src.allowed_configs = config_choices
ReadColorsFromString(starting_colors || atom_target?.greyscale_colors)
if(target)
RegisterSignal(target, COMSIG_QDELETING, PROC_REF(ui_close))
refresh_preview()
/datum/greyscale_modify_menu/Destroy()
target = null
user = null
return ..()
/datum/greyscale_modify_menu/ui_state(mob/user)
return unlocked ? GLOB.always_state : GLOB.greyscale_menu_state
/datum/greyscale_modify_menu/ui_close()
qdel(src)
/datum/greyscale_modify_menu/ui_interact(mob/user, datum/tgui/ui)
ui = SStgui.try_update_ui(user, src, ui)
if(!ui)
ui = new(user, src, "GreyscaleModifyMenu")
ui.open()
/datum/greyscale_modify_menu/ui_data(mob/user)
var/list/data = list()
data["greyscale_config"] = "[config.name]"
var/list/color_data = list()
data["colors"] = color_data
for(var/i in 1 to config.expected_colors)
color_data += list(list(
"index" = i,
"value" = split_colors[i]
))
data["generate_full_preview"] = generate_full_preview
data["unlocked"] = unlocked
data["refreshing"] = refreshing
data["monitoring_files"] = !!(config.datum_flags & DF_ISPROCESSING)
data["sprites_dir"] = dir2text(sprite_dir)
data["icon_state"] = icon_state
data["sprites"] = sprite_data
return data
/datum/greyscale_modify_menu/ui_act(action, params)
. = ..()
if(.)
return
switch(action)
if("select_config")
var/datum/greyscale_config/new_config = input(
usr,
"Choose a new greyscale configuration to use",
"Greyscale Modification Menu",
"[config.type]"
) as anything in allowed_configs
new_config = allowed_configs[new_config]
new_config = SSgreyscale.configurations[new_config] || new_config
if(!isnull(new_config) && config != new_config)
change_config(new_config)
queue_refresh()
if("load_config_from_string")
if(!(params["config_string"] in allowed_configs))
return
var/datum/greyscale_config/new_config = SSgreyscale.configurations[params["config_string"]]
if(!isnull(new_config) && config != new_config)
change_config(new_config)
queue_refresh()
if("toggle_full_preview")
if(!generate_full_preview && !unlocked)
return
generate_full_preview = !generate_full_preview
queue_refresh()
if("recolor")
var/index = text2num(params["color_index"])
var/new_color = lowertext(params["new_color"])
if(split_colors[index] != new_color && (findtext(new_color, GLOB.is_color) || (unlocked && findtext(new_color, GLOB.is_alpha_color))))
split_colors[index] = new_color
queue_refresh()
if("recolor_from_string")
var/full_color_string = lowertext(params["color_string"])
if(full_color_string != split_colors.Join() && ReadColorsFromString(full_color_string))
queue_refresh()
if("pick_color")
var/group = params["color_index"]
var/new_color = input(
usr,
"Choose color for greyscale color group [group]:",
"Greyscale Modification Menu",
split_colors[group]
) as color|null
if(new_color)
split_colors[group] = new_color
queue_refresh()
if("random_color")
var/group = text2num(params["color_index"])
randomize_color(group)
queue_refresh()
if("random_all_colors")
for(var/i in 1 to length(split_colors))
randomize_color(i)
queue_refresh()
if("select_icon_state")
var/new_icon_state = params["new_icon_state"]
if(!config.icon_states[new_icon_state])
return
icon_state = new_icon_state
queue_refresh()
if("apply")
apply_callback.Invoke(src)
if("refresh_file")
if(!unlocked || !check_rights(R_DEBUG))
return
if(length(GLOB.player_list) > 1)
var/check = alert(
user,
{"Other players are connected to the server, are you sure you want to refresh all greyscale configurations?\n
This is highly likely to cause a lag spike for a few seconds."},
"Refresh Greyscale Configurations",
"Yes",
"Cancel"
)
if(check != "Yes")
return
config.Refresh(loadFromDisk=TRUE)
if("save_dmi")
if(!unlocked)
return
config.SaveOutput(split_colors.Copy(1, config.expected_colors+1))
if("change_dir")
sprite_dir = text2dir(params["new_sprite_dir"])
queue_refresh()
if("toggle_mass_refresh")
if(!unlocked || !check_rights(R_DEBUG))
return
if(config.datum_flags & DF_ISPROCESSING)
config.DisableAutoRefresh(remove_all=TRUE)
return
if(length(GLOB.player_list) > 1)
var/check = alert(
user,
{"Other players are connected to the server, are you sure you want to automatically refresh all greyscale configurations?\n
This is highly likely to cause massive amounts of lag as every object in the game will be iterated over every few seconds."},
"Auto-Refresh Greyscale Configurations",
"Yes",
"Cancel"
)
if(check != "Yes")
return
config.EnableAutoRefresh(config_owner_type)
/datum/greyscale_modify_menu/proc/ReadColorsFromString(colorString)
var/list/new_split_colors = list()
var/list/colors = splittext(colorString, "#")
for(var/index in 2 to length(colors))
var/color = "#[colors[index]]"
if(!findtext(color, GLOB.is_color) && (!unlocked || !findtext(color, GLOB.is_alpha_color)))
return FALSE
new_split_colors += color
split_colors = new_split_colors
return TRUE
/datum/greyscale_modify_menu/proc/randomize_color(color_index)
var/new_color = "#"
for(var/i in 1 to 3)
new_color += num2hex(rand(0, 255), 2)
split_colors[color_index] = new_color
/datum/greyscale_modify_menu/proc/change_config(datum/greyscale_config/new_config)
if(config)
UnregisterSignal(config, COMSIG_GREYSCALE_CONFIG_REFRESHED)
config = new_config
RegisterSignal(config, COMSIG_GREYSCALE_CONFIG_REFRESHED, PROC_REF(queue_refresh))
/datum/greyscale_modify_menu/proc/queue_refresh()
SIGNAL_HANDLER
refreshing = TRUE
addtimer(CALLBACK(src, PROC_REF(refresh_preview)), 1 SECONDS, TIMER_UNIQUE | TIMER_OVERRIDE)
/datum/greyscale_modify_menu/proc/refresh_preview()
for(var/i in length(split_colors) + 1 to config.expected_colors)
LAZYADD(split_colors, rgb(100, 100, 100))
var/list/used_colors = split_colors.Copy(1, config.expected_colors+1)
sprite_data = list()
var/list/generated_icon_states = list()
for(var/state in config.icon_states)
generated_icon_states += state // We don't want the values from this keyed list
sprite_data["icon_states"] = generated_icon_states
if(!(icon_state in generated_icon_states))
if(isatom(target))
var/atom/atom_target = target
icon_state = atom_target.icon_state
if(!(icon_state in generated_icon_states))
icon_state = pick(generated_icon_states)
else
icon_state = pick(generated_icon_states)
var/image/finished
var/time_spent = TICK_USAGE
if(!generate_full_preview)
finished = image(config.GenerateBundle(used_colors), icon_state=icon_state)
time_spent = TICK_USAGE - time_spent
else
var/list/data = config.GenerateDebug(used_colors.Join())
time_spent = TICK_USAGE - time_spent
finished = image(data["icon"], icon_state=icon_state)
var/list/steps = list()
sprite_data["steps"] = steps
var/list/icon_state_data = data["steps"][icon_state]
for(var/list/step as anything in icon_state_data)
CHECK_TICK
var/image/layer = image(step["step"])
var/image/result = image(step["result"])
// SKYRAT EDIT BEGIN - Bringing back the GAGS coloring menu
steps += list(
list(
"layer"=icon2html(layer, user, dir=sprite_dir, sourceonly=TRUE),
"result"=icon2html(result, user, dir=sprite_dir, sourceonly=TRUE),
"config_name"=step["config_name"]
)
)
// SKYRAT EDIT END
sprite_data["time_spent"] = TICK_DELTA_TO_MS(time_spent)
sprite_data["finished"] = icon2html(finished, user, dir=sprite_dir, sourceonly=TRUE)
refreshing = FALSE
/datum/greyscale_modify_menu/proc/Unlock()
allowed_configs = SSgreyscale.configurations
unlocked = TRUE
/datum/greyscale_modify_menu/proc/DefaultApply()
var/atom/atom_target = target
atom_target.set_greyscale(split_colors, config.type)
/// Gets the top level type that first uses the configuration in this type path
/datum/greyscale_modify_menu/proc/SetupConfigOwner()
if(!isatom(target))
return
var/atom/current = target.type
var/atom/parent = target.parent_type
if(!initial(current.greyscale_config))
return
while(initial(current.greyscale_config) == initial(parent.greyscale_config))
current = parent
parent = type2parent(current)
config_owner_type = current
/// Used for spray painting items in the gags_recolorable component
/datum/greyscale_modify_menu/spray_paint
var/obj/item/toy/crayon/spraycan/spraycan = null
/datum/greyscale_modify_menu/spray_paint/New(atom/target, client/user, list/allowed_configs, datum/callback/apply_callback, starting_icon_state, starting_config, starting_colors, obj/item/toy/crayon/spraycan/used_spraycan)
..()
spraycan = used_spraycan
/datum/greyscale_modify_menu/spray_paint/ui_status(mob/user, datum/ui_state/state)
return min(
ui_status_only_living(user, target),
ui_status_user_is_abled(user, target),
ui_status_user_strictly_adjacent(user, target),
user.is_holding(spraycan)? UI_INTERACTIVE : UI_CLOSE
)