Files
Bubberstation/code/datums/components/keep_me_secure.dm
LemonInTheDark ae5a4f955d Pulls apart the vestiges of components still hanging onto signals (#75914)
## About The Pull Request

Signals were initially only usable with component listeners, which while
no longer the case has lead to outdated documentation, names, and a
similar location in code.

This pr pulls the two apart. Partially because mso thinks we should, but
also because they really aren't directly linked anymore, and having them
in this midstate just confuses people.

[Renames comp_lookup to listen_lookup, since that's what it
does](102b79694f)

[Moves signal procs over to their own
file](33d07d01fd)

[Renames the PREQDELETING and QDELETING comsigs to drop the parent bit
since they can hook to more then just comps
now](335ea4ad08)

[Does something similar to the attackby comsigs (PARENT ->
ATOM)](210e57051d)

[And finally passes over the examine
signals](65917658fb)

## Why It's Good For The Game

Code makes more sense, things are better teased apart, s just good imo

## Changelog
🆑
refactor: Pulled apart the last vestiges of names/docs directly linking
signals to components
/🆑
2023-06-09 06:14:31 +00:00

77 lines
2.6 KiB
Plaintext

/**
* ### Keep Me Secure component!
*
* Component that attaches to items, invoking a function to react when left unmoved and unsecured for too long.
* Used for Nuclear Authentication Disks, and whiny plushy as an example (which changes sprites depending on whether it considers itself secure.)
*/
/datum/component/keep_me_secure
/// callback for the parent being secure
var/datum/callback/secured_callback
/// callback for the parent being unsecured
var/datum/callback/unsecured_callback
/// The last secure location the parent was at.
var/turf/last_secured_location
/// The last world time the parent moved.
var/last_move
/datum/component/keep_me_secure/Initialize(secured_callback, unsecured_callback)
if(!isitem(parent))
return COMPONENT_INCOMPATIBLE
src.secured_callback = secured_callback
src.unsecured_callback = unsecured_callback
/datum/component/keep_me_secure/RegisterWithParent()
last_move = world.time
if (secured_callback || unsecured_callback)
START_PROCESSING(SSobj, src)
RegisterSignal(parent, COMSIG_ATOM_EXAMINE, PROC_REF(on_examine))
RegisterSignal(parent, COMSIG_ATOM_EXAMINE_MORE, PROC_REF(on_examine_more))
/datum/component/keep_me_secure/UnregisterFromParent()
STOP_PROCESSING(SSobj, src)
UnregisterSignal(parent, COMSIG_ATOM_EXAMINE)
/// Returns whether the game is supposed to consider the parent "secure".
/datum/component/keep_me_secure/proc/is_secured()
var/obj/item/item_parent = parent
if (last_secured_location == get_turf(item_parent))
return FALSE
var/mob/holder = item_parent.pulledby || get(parent, /mob)
if (isnull(holder?.client))
return FALSE
return TRUE
/datum/component/keep_me_secure/process(seconds_per_tick)
if(is_secured())
last_secured_location = get_turf(parent)
last_move = world.time
if(secured_callback)
secured_callback.Invoke(last_move)
else
if(unsecured_callback)
unsecured_callback.Invoke(last_move)
/// signal sent when parent is examined
/datum/component/keep_me_secure/proc/on_examine(mob/living/source, mob/examiner, list/examine_list)
SIGNAL_HANDLER
examine_list += span_boldnotice("[parent] should be secured at all times.")
if(is_secured())
examine_list += span_notice("Right now, it is.")
else
examine_list += span_warning("Right now, it isn't...")
examine_list += span_notice("Examine closer for more info.")
/// signal sent when parent is examined more
/datum/component/keep_me_secure/proc/on_examine_more(mob/living/source, mob/examiner, list/examine_list)
SIGNAL_HANDLER
examine_list += span_notice("For [parent] to be secure, it needs to be:")
examine_list += span_notice("1. Always on the move, and...")
examine_list += span_notice("2. Held or dragged by someone.")