reflection

A simple-ish component that reflects the icons of movables on the parent like a mirror. Sadly, there's no easy way to make the SOUTH dir reflection flip the visual so that you can see the back NORTH dir of a target while it's facing SOUTH beside adding the VIS_INHERIT_DIR flag to the target movable, which I'm not doing to spare eventual issues with other vis overlays in the future.

Vars
alpha	the transparency channel value of the reflection holder.
can_reflect	A callback used check to know which movables should be reflected and which not.
check_reflect_signals	List of signals registered on reflected atoms to update their reflections.
reflected_dir	The direction from which the component gets its visual overlays. The visuals are also flipped horizontally or vertically based on it.
reflected_movables	A lazy assoc list that keeps track of all movables in range that either could be reflected or are reflected.
reflection_filter	the filter data added to reflection holder.
reflection_holder	the movable which the reflected movables are attached to, in turn added to the vis contents of the parent.
reflection_matrix	the base matrix used by reflections
update_signals	A list of signals that when sent to the parent, will force the comp to recalculate the reflected movables.
Procs
Initialize	Init Args
check_can_reflect	Checks if the target movable can be reflected or not.
copy_appearance_to_reflection	Handles updating the appearance of the reflection to match the target movable.
get_reflection_targets	Unsets the old reflected movables and sets it with new ones.
on_dir_change	Called when the parent changes its direction.
on_movable_entered_or_initialized	Called when a movable enters a turf within the connected range
on_movable_exited	Called when a movable exits a turf within the connected range
set_reflection	Turns the allowed reflected direction alongside the parent's dir. then calls get_reflection_targets.
update_reflection	Called when the target movable changes its appearance or dir.

Var Details

var
alpha
–

the transparency channel value of the reflection holder.

var
can_reflect
– /datum/callback

A callback used check to know which movables should be reflected and which not.

var
check_reflect_signals
– /list

List of signals registered on reflected atoms to update their reflections.

var
reflected_dir
–

The direction from which the component gets its visual overlays. The visuals are also flipped horizontally or vertically based on it.

var
reflected_movables
– /list

A lazy assoc list that keeps track of all movables in range that either could be reflected or are reflected.

The key is the movable, and the value is the reflection object (or null - the reflection object is also lazy loaded).

var
reflection_filter
– /list

the filter data added to reflection holder.

var
reflection_holder
– /obj/effect/abstract

the movable which the reflected movables are attached to, in turn added to the vis contents of the parent.

var
reflection_matrix
– /matrix

the base matrix used by reflections

var
update_signals
– /list

A list of signals that when sent to the parent, will force the comp to recalculate the reflected movables.

Proc Details

↑
Initialize
(set_reflected_dir, /list/reflection_filter, /matrix/reflection_matrix, /datum/callback/can_reflect, alpha, /list/update_signals, /list/check_reflect_signals)

Init Args

set_reflected_dir: Optional: What dir to reflect. If not provided, uses (and updates to) the parent's dir.
reflection_filter: Optional: A list of filters to apply to the reflection.
reflection_matrix: Optional: A matrix to apply as the transform of the reflection.
can_reflect: Optional: A callback to check if a movable should be reflected.
alpha: The transparency of the reflection holder.
update_signals: Optional: Additional signals to provide to update_signals (to check for when to recalculate all reflections).
check_reflect_signals: Optional: Additional signals to provide to check_reflect_signals (to check for when to update a single reflection).

proc
check_can_reflect
(/atom/movable/target)

Checks if the target movable can be reflected or not.

proc
copy_appearance_to_reflection
(/obj/effect/abstract/reflection, /atom/movable/target)

Handles updating the appearance of the reflection to match the target movable.

proc
get_reflection_targets
(/atom/movable/source)

Unsets the old reflected movables and sets it with new ones.

proc
on_dir_change
(/atom/movable/source, old_dir, new_dir)

Called when the parent changes its direction.

proc
on_movable_entered_or_initialized
(/atom/movable/source, /atom/movable/arrived)

Called when a movable enters a turf within the connected range

proc
on_movable_exited
(/atom/movable/source, /atom/movable/gone)

Called when a movable exits a turf within the connected range

proc
set_reflection
(new_dir)

Turns the allowed reflected direction alongside the parent's dir. then calls get_reflection_targets.

proc
update_reflection
(/atom/movable/source)

Called when the target movable changes its appearance or dir.

reflection /datum/component/reflection

Vars

Procs

Var Details

var alpha –

var can_reflect – /datum/callback

var check_reflect_signals – /list

var reflected_dir –

var reflected_movables – /list

var reflection_filter – /list

var reflection_holder – /obj/effect/abstract

var reflection_matrix – /matrix

var update_signals – /list

Proc Details

↑Initialize(set_reflected_dir, /list/reflection_filter, /matrix/reflection_matrix, /datum/callback/can_reflect, alpha, /list/update_signals, /list/check_reflect_signals)

proc check_can_reflect(/atom/movable/target)

proc copy_appearance_to_reflection(/obj/effect/abstract/reflection, /atom/movable/target)

proc get_reflection_targets(/atom/movable/source)

proc on_dir_change(/atom/movable/source, old_dir, new_dir)

proc on_movable_entered_or_initialized(/atom/movable/source, /atom/movable/arrived)

proc on_movable_exited(/atom/movable/source, /atom/movable/gone)

proc set_reflection(new_dir)

proc update_reflection(/atom/movable/source)