mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2025-12-26 09:32:21 +00:00
* Adds a unit test to stop elements from using identical lists for their arguments. (#76322) ## About The Pull Request Ok, so a few days ago I made an issue report about multiple instances of identical elements being generated because of uncached lists. ninjanomnom (the mind being the element datums) cleared it up and said an implementation of GetIdFromArguments() that also checks the list contents wouldn't be worth the performance cost, while adding that a unit test should be written to check that it doesn't happen at least during init, which should catch a good chunk of cases. Also, i'm stopping RemoveElement() from initializing new elements whenever a cached element is not found. Ideally, there should be a focus only unit test for that too, but that's something we should tackle on a different PR. Some of the code comments may be a tad inaccurate, as much as I'd like to blame drowsiness for it. Regardless, the unit test takes less than 0.2 seconds to complete on my potato so it's fairly lite. ## Why It's Good For The Game This will close #76279. ## Changelog No player-facing change to be logged. * Adds a unit test to stop elements from using identical lists for their arguments. * Fixes unit test * seeing double --------- Co-authored-by: Ghom <42542238+Ghommie@users.noreply.github.com> Co-authored-by: Giz <13398309+vinylspiders@users.noreply.github.com>
177 lines
6.7 KiB
Plaintext
177 lines
6.7 KiB
Plaintext
/datum/element/decal
|
|
element_flags = ELEMENT_BESPOKE|ELEMENT_DETACH_ON_HOST_DESTROY|ELEMENT_DONT_SORT_LIST_ARGS
|
|
argument_hash_start_idx = 2
|
|
/// Whether this decal can be cleaned.
|
|
var/cleanable
|
|
/// A description this decal appends to the target's examine message.
|
|
var/description
|
|
/// If true this was initialized with no set direction - will follow the parent dir.
|
|
var/directional
|
|
/// The base icon state that this decal was initialized with.
|
|
var/base_icon_state
|
|
/// What smoothing junction this was initialized with.
|
|
var/smoothing
|
|
/// The overlay applied by this decal to the target.
|
|
var/mutable_appearance/pic
|
|
|
|
/// Remove old decals and apply new decals after rotation as necessary
|
|
/datum/controller/subsystem/processing/dcs/proc/rotate_decals(datum/source, old_dir, new_dir)
|
|
SIGNAL_HANDLER
|
|
|
|
if(old_dir == new_dir)
|
|
return
|
|
|
|
var/list/datum/element/decal/old_decals = list() //instances
|
|
SEND_SIGNAL(source, COMSIG_ATOM_DECALS_ROTATING, old_decals)
|
|
|
|
if(!length(old_decals))
|
|
UnregisterSignal(source, COMSIG_ATOM_DIR_CHANGE)
|
|
return
|
|
|
|
var/list/resulting_decals_params = list() // param lists
|
|
for(var/datum/element/decal/rotating as anything in old_decals)
|
|
resulting_decals_params += list(rotating.get_rotated_parameters(old_dir,new_dir))
|
|
|
|
//Instead we could generate ids and only remove duplicates to save on churn on four-corners symmetry ?
|
|
for(var/datum/element/decal/decal in old_decals)
|
|
decal.Detach(source)
|
|
|
|
for(var/result in resulting_decals_params)
|
|
source.AddElement(/datum/element/decal, result["icon"], result["icon_state"], result["dir"], PLANE_TO_TRUE(result["plane"]), result["layer"], result["alpha"], result["color"], result["smoothing"], result["cleanable"], result["desc"])
|
|
|
|
|
|
/datum/element/decal/proc/get_rotated_parameters(old_dir,new_dir)
|
|
var/rotation = 0
|
|
if(directional) //Even when the dirs are the same rotation is coming out as not 0 for some reason
|
|
rotation = SIMPLIFY_DEGREES(dir2angle(new_dir)-dir2angle(old_dir))
|
|
new_dir = turn(pic.dir,-rotation)
|
|
return list(
|
|
"icon" = pic.icon,
|
|
"icon_state" = base_icon_state,
|
|
"dir" = new_dir,
|
|
"plane" = pic.plane,
|
|
"layer" = pic.layer,
|
|
"alpha" = pic.alpha,
|
|
"color" = pic.color,
|
|
"smoothing" = smoothing,
|
|
"cleanable" = cleanable,
|
|
"desc" = description
|
|
)
|
|
|
|
|
|
|
|
/datum/element/decal/Attach(atom/target, _icon, _icon_state, _dir, _plane=FLOAT_PLANE, _layer=FLOAT_LAYER, _alpha=255, _color, _smoothing, _cleanable=FALSE, _description, mutable_appearance/_pic)
|
|
. = ..()
|
|
if(!isatom(target))
|
|
return ELEMENT_INCOMPATIBLE
|
|
if(_pic)
|
|
pic = _pic
|
|
else if(!generate_appearance(_icon, _icon_state, _dir, _plane, _layer, _color, _alpha, _smoothing, target))
|
|
return ELEMENT_INCOMPATIBLE
|
|
description = _description
|
|
cleanable = _cleanable
|
|
directional = _dir
|
|
base_icon_state = _icon_state
|
|
smoothing = _smoothing
|
|
|
|
RegisterSignal(target, COMSIG_ATOM_UPDATE_OVERLAYS, PROC_REF(apply_overlay), TRUE)
|
|
if(target.flags_1 & INITIALIZED_1)
|
|
target.update_appearance(UPDATE_OVERLAYS) //could use some queuing here now maybe.
|
|
else
|
|
RegisterSignal(target,COMSIG_ATOM_AFTER_SUCCESSFUL_INITIALIZE, PROC_REF(late_update_icon), TRUE)
|
|
if(isitem(target))
|
|
INVOKE_ASYNC(target, TYPE_PROC_REF(/obj/item/, update_slot_icon), TRUE)
|
|
if(_dir)
|
|
RegisterSignal(target, COMSIG_ATOM_DECALS_ROTATING, PROC_REF(shuttle_rotate), TRUE)
|
|
SSdcs.RegisterSignal(target, COMSIG_ATOM_DIR_CHANGE, TYPE_PROC_REF(/datum/controller/subsystem/processing/dcs, rotate_decals), override=TRUE)
|
|
if(!isnull(_smoothing))
|
|
RegisterSignal(target, COMSIG_ATOM_SMOOTHED_ICON, PROC_REF(smooth_react), TRUE)
|
|
if(_cleanable)
|
|
RegisterSignal(target, COMSIG_COMPONENT_CLEAN_ACT, PROC_REF(clean_react), TRUE)
|
|
if(_description)
|
|
RegisterSignal(target, COMSIG_ATOM_EXAMINE, PROC_REF(examine),TRUE)
|
|
|
|
RegisterSignal(target, COMSIG_TURF_ON_SHUTTLE_MOVE, PROC_REF(shuttle_move_react),TRUE)
|
|
|
|
/**
|
|
* ## generate_appearance
|
|
*
|
|
* If the decal was not given an appearance, it will generate one based on the other given arguments.
|
|
* element won't be compatible if it cannot do either
|
|
* all args are fed into creating an image, they are byond vars for images you'll recognize in the byond docs
|
|
* (except source, source is the object whose appearance we're copying.)
|
|
*/
|
|
/datum/element/decal/proc/generate_appearance(_icon, _icon_state, _dir, _plane, _layer, _color, _alpha, _smoothing, source)
|
|
if(!_icon || !_icon_state)
|
|
return FALSE
|
|
var/temp_image = image(_icon, null, isnull(_smoothing) ? _icon_state : "[_icon_state]-[_smoothing]", _layer, _dir)
|
|
pic = new(temp_image)
|
|
var/atom/atom_source = source
|
|
SET_PLANE_EXPLICIT(pic, _plane, atom_source)
|
|
pic.color = _color
|
|
pic.alpha = _alpha
|
|
return TRUE
|
|
|
|
/datum/element/decal/Detach(atom/source)
|
|
UnregisterSignal(source, list(COMSIG_ATOM_DIR_CHANGE, COMSIG_COMPONENT_CLEAN_ACT, COMSIG_ATOM_EXAMINE, COMSIG_ATOM_UPDATE_OVERLAYS, COMSIG_TURF_ON_SHUTTLE_MOVE, COMSIG_ATOM_SMOOTHED_ICON))
|
|
SSdcs.UnregisterSignal(source, COMSIG_ATOM_DIR_CHANGE)
|
|
source.update_appearance(UPDATE_OVERLAYS)
|
|
if(isitem(source))
|
|
INVOKE_ASYNC(source, TYPE_PROC_REF(/obj/item/, update_slot_icon))
|
|
SEND_SIGNAL(source, COMSIG_TURF_DECAL_DETACHED, description, cleanable, directional, pic)
|
|
return ..()
|
|
|
|
/datum/element/decal/proc/late_update_icon(atom/source)
|
|
SIGNAL_HANDLER
|
|
|
|
if(istype(source) && !(source.flags_1 & DECAL_INIT_UPDATE_EXPERIENCED_1))
|
|
source.flags_1 |= DECAL_INIT_UPDATE_EXPERIENCED_1 // I am so sorry, but it saves like 80ms I gotta
|
|
source.update_appearance(UPDATE_OVERLAYS)
|
|
UnregisterSignal(source, COMSIG_ATOM_AFTER_SUCCESSFUL_INITIALIZE)
|
|
|
|
/datum/element/decal/proc/apply_overlay(atom/source, list/overlay_list)
|
|
SIGNAL_HANDLER
|
|
|
|
overlay_list += pic
|
|
|
|
/datum/element/decal/proc/clean_react(datum/source, clean_types)
|
|
SIGNAL_HANDLER
|
|
|
|
if(clean_types & cleanable)
|
|
Detach(source)
|
|
return COMPONENT_CLEANED
|
|
return NONE
|
|
|
|
/datum/element/decal/proc/examine(datum/source, mob/user, list/examine_list)
|
|
SIGNAL_HANDLER
|
|
|
|
examine_list += description
|
|
|
|
/datum/element/decal/proc/shuttle_move_react(datum/source, turf/new_turf)
|
|
SIGNAL_HANDLER
|
|
|
|
if(new_turf == source)
|
|
return
|
|
Detach(source)
|
|
new_turf.AddElement(type, pic.icon, base_icon_state, directional, pic.plane, pic.layer, pic.alpha, pic.color, smoothing, cleanable, description)
|
|
|
|
/datum/element/decal/proc/shuttle_rotate(datum/source, list/datum/element/decal/rotating)
|
|
SIGNAL_HANDLER
|
|
rotating += src
|
|
|
|
/**
|
|
* Reacts to the source atom smoothing.
|
|
*
|
|
* Arguments:
|
|
* - [source][/atom]: The source of the signal and recently smoothed atom.
|
|
*/
|
|
/datum/element/decal/proc/smooth_react(atom/source)
|
|
SIGNAL_HANDLER
|
|
var/smoothing_junction = source.smoothing_junction
|
|
if(smoothing_junction == smoothing)
|
|
return NONE
|
|
|
|
Detach(source)
|
|
source.AddElement(type, pic.icon, base_icon_state, directional, PLANE_TO_TRUE(pic.plane), pic.layer, pic.alpha, pic.color, smoothing_junction, cleanable, description)
|
|
return NONE
|