pathfind

Vars
avoid	A specific turf we're avoiding, like if a mulebot is being blocked by someone t-posing in a doorway we're trying to get through
max_distance	Limits how far we can search before giving up on a path
on_finish	The callbacks to invoke when we're done working, passing in the completed product Invoked in order
pass_info	Datum that holds the canpass info of this pathing attempt. This is what CanAstarPass sees
simulated_only	Space is big and empty, if this is TRUE then we ignore pathing through unsimulated tiles
start	The turf we started at
Procs
early_exit	early_exit() is called when something goes wrong in processing, and we need to halt the pathfinding NOW
finished	Cleanup pass for the pathfinder. This tidies up the path, and fufills the pathfind's obligations
hand_back	Call to return a value to whoever spawned this pathfinding work Will fail if it's already been called
search_step	search_step() is the workhorse of pathfinding. It'll do the searching logic, and will slowly build up a path returns TRUE if everything is stable, FALSE if the pathfinding logic has failed, and we need to abort
start	"starts" off the pathfinding, by storing the values this datum will need to work later on returns FALSE if it fails to setup properly, TRUE otherwise

Var Details

var
avoid
– /turf

A specific turf we're avoiding, like if a mulebot is being blocked by someone t-posing in a doorway we're trying to get through

var
max_distance
–

Limits how far we can search before giving up on a path

var
on_finish
– /datum/callback

The callbacks to invoke when we're done working, passing in the completed product Invoked in order

var
pass_info
– /datum/can_pass_info

Datum that holds the canpass info of this pathing attempt. This is what CanAstarPass sees

var
simulated_only
–

Space is big and empty, if this is TRUE then we ignore pathing through unsimulated tiles

var
start
– /turf

The turf we started at

Proc Details

proc
early_exit
()

early_exit() is called when something goes wrong in processing, and we need to halt the pathfinding NOW

proc
finished
()

Cleanup pass for the pathfinder. This tidies up the path, and fufills the pathfind's obligations

proc
hand_back
(value)

Call to return a value to whoever spawned this pathfinding work Will fail if it's already been called

proc
search_step
()

search_step() is the workhorse of pathfinding. It'll do the searching logic, and will slowly build up a path returns TRUE if everything is stable, FALSE if the pathfinding logic has failed, and we need to abort

proc
start
()

"starts" off the pathfinding, by storing the values this datum will need to work later on returns FALSE if it fails to setup properly, TRUE otherwise

pathfind /datum/pathfind

Vars

Procs

Var Details

var avoid – /turf

var max_distance –

var on_finish – /datum/callback

var pass_info – /datum/can_pass_info

var simulated_only –

var start – /turf