move_loop

Template class of the movement datums, handles the timing portion of the loops

Vars
controller	The subsystem we're processing on
delay	Delay between each move in deci-seconds
extra_info	An extra reference we pass around It is on occasion useful to have a reference to some datum without storing it on the moving object Mostly comes up in high performance senarios where we care about things being singletons This feels horrible, but constantly making components seems worse
flags	Bitfield of different things that affect how a loop operates, and other mechanics around it as well.
lifetime	Time till we stop processing in deci-seconds, defaults to forever
moving	The thing we're moving about
owner	The movement packet that owns us
priority	Defines how different move loops override each other. Higher numbers beat lower numbers
queued_time	The time we are CURRENTLY queued for processing Do not modify this directly
status	Status bitfield for what state the move loop is currently in
timer	The next time we should process Used primarially as a hint to be reasoned about by our [controller], and as the id of our bucket
Procs
compare_loops	check if this exact moveloop datum already exists (in terms of vars) so we can avoid creating a new one to overwrite the old duplicate
loop_started	Called when a loop is starting by a movement subsystem
loop_stopped	Called when a loop is stopped, doesn't stop the loop itself
move	Handles the actual move, overriden by children Returns FALSE if nothing happen, TRUE otherwise
pause_for	Pauses the move loop for some passed in period This functionally means shifting its timer up, and clearing it from its current bucket
pause_loop	Pause our loop untill restarted with resume_loop()
resume_loop	Resume our loop after being paused by pause_loop()
set_delay	Exists as a helper so outside code can modify delay in a sane way

Var Details

var
controller
– /datum/controller/subsystem/movement

The subsystem we're processing on

var
delay
–

Delay between each move in deci-seconds

var
extra_info
– /datum

An extra reference we pass around It is on occasion useful to have a reference to some datum without storing it on the moving object Mostly comes up in high performance senarios where we care about things being singletons This feels horrible, but constantly making components seems worse

var
flags
–

Bitfield of different things that affect how a loop operates, and other mechanics around it as well.

var
lifetime
–

Time till we stop processing in deci-seconds, defaults to forever

var
moving
– /atom/movable

The thing we're moving about

var
owner
– /datum/movement_packet

The movement packet that owns us

var
priority
–

Defines how different move loops override each other. Higher numbers beat lower numbers

var
queued_time
–

The time we are CURRENTLY queued for processing Do not modify this directly

var
status
–

Status bitfield for what state the move loop is currently in

var
timer
–

The next time we should process Used primarially as a hint to be reasoned about by our [controller], and as the id of our bucket

Proc Details

proc
compare_loops
(/datum/move_loop/loop_type, priority, flags, extra_info, delay, timeout)

check if this exact moveloop datum already exists (in terms of vars) so we can avoid creating a new one to overwrite the old duplicate

proc
loop_started
()

Called when a loop is starting by a movement subsystem

proc
loop_stopped
()

Called when a loop is stopped, doesn't stop the loop itself

proc
move
()

Handles the actual move, overriden by children Returns FALSE if nothing happen, TRUE otherwise

proc
pause_for
(time)

Pauses the move loop for some passed in period This functionally means shifting its timer up, and clearing it from its current bucket

proc
pause_loop
()

Pause our loop untill restarted with resume_loop()

proc
resume_loop
()

Resume our loop after being paused by pause_loop()

proc
set_delay
(new_delay)

Exists as a helper so outside code can modify delay in a sane way

move_loop /datum/move_loop

Vars

Procs

Var Details

var controller – /datum/controller/subsystem/movement

var delay –

var extra_info – /datum

var flags –

var lifetime –

var moving – /atom/movable

var owner – /datum/movement_packet

var priority –

var queued_time –

var status –

var timer –