lock_on_cursor

Lock on Cursor component

Finds the nearest targets to your cursor and passes them into a callback, also drawing an icon on top of them.

Vars
can_target_callback	Callback to call in order to validate a potential target
current_ranging_id	Ranging ID for some kind of tick check safety calculation
immune_weakrefs	Cache of weakrefs to ignore targetting formatted as `list(weakref = TRUE)`
lock_amount	Number of things we can target at once
lock_appearance	Appearance to overlay onto whatever we are targetting
lock_cursor_range	Range to search for targets from the cursor position
lock_images	Current images we are displaying to the client
locked_weakrefs	Weakrefs to current locked targets
mouse_tracker	Full screen overlay which is used to track mouse position
on_lock	Callback to call when we have decided on our targets, is passed the list of final targets
target_typecache	Typecache of things we are allowed to target
Procs
can_target	Returns true if target is a valid target
clear_invalid_targets	Removes targets which are out of range or don't exist any more
clear_visuals	Removes target overlays
find_targets	Replace our targets with new ones
get_nearest	Returns the nearest targets to the current cursor position
refresh_visuals	Reset the overlays on all targets
show_visuals	Adds overlays to all targets

Var Details

var
can_target_callback
– /datum/callback

Callback to call in order to validate a potential target

var
current_ranging_id
–

Ranging ID for some kind of tick check safety calculation

var
immune_weakrefs
– /list

Cache of weakrefs to ignore targetting formatted as list(weakref = TRUE)

var
lock_amount
–

Number of things we can target at once

var
lock_appearance
– /mutable_appearance

Appearance to overlay onto whatever we are targetting

var
lock_cursor_range
–

Range to search for targets from the cursor position

var
lock_images
– /list/image

Current images we are displaying to the client

var
locked_weakrefs
– /list

Weakrefs to current locked targets

var
mouse_tracker
– /atom/movable/screen/fullscreen/cursor_catcher/lock_on

Full screen overlay which is used to track mouse position

var
on_lock
– /datum/callback

Callback to call when we have decided on our targets, is passed the list of final targets

var
target_typecache
– /list

Typecache of things we are allowed to target

Proc Details

proc
can_target
(/atom/target)

Returns true if target is a valid target

proc
clear_invalid_targets
()

Removes targets which are out of range or don't exist any more

proc
clear_visuals
()

Removes target overlays

proc
find_targets
()

Replace our targets with new ones

proc
get_nearest
()

Returns the nearest targets to the current cursor position

proc
refresh_visuals
()

Reset the overlays on all targets

proc
show_visuals
()

Adds overlays to all targets

lock_on_cursor /datum/component/lock_on_cursor

Vars

Procs

Var Details

var can_target_callback – /datum/callback

var current_ranging_id –

var immune_weakrefs – /list

var lock_amount –

var lock_appearance – /mutable_appearance

var lock_cursor_range –

var lock_images – /list/image

var locked_weakrefs – /list

var mouse_tracker – /atom/movable/screen/fullscreen/cursor_catcher/lock_on

var on_lock – /datum/callback

var target_typecache – /list