ai_behavior

Base type for AI behavior leaf nodes in the behavior tree system. setup() is called once on first activation, perform() each tick while running. Returns BT_SUCCESS / BT_FAILURE on completion, BT_RUNNING while active.

Vars
async_finished	TRUE once async finished and via finish_async
async_result_flags	AI_BEHAVIOR_* flags that came out of async perform
async_running	TRUE while an async perform kicked off by start_async() is going
behavior_flags	Flags for extra behavior (see AI_BEHAVIOR_* defines)
failed_last_perform	TRUE when the last perform() failed and we are waiting out next_perform_time to say we failed
next_perform_time	world.time when perform() may next be called.
running	TRUE after setup() has been called and before finish_action() completes.
time_between_perform	Cooldown between perform() calls; do not read directly use get_cooldown()
Procs
async_still_valid	Call from an async behavior after its sleeping call, before committing side effects. FALSE means the behavior was aborted/reset mid-flight bail out without side effects.
finish_action	Called when the behavior finishes (succeeded or failed). Subtypes should call ..().
finish_async	Call from an async behavior to commit its result. No-op if the behavior was aborted mid-flight.
get_cooldown	Returns the cooldown to apply after a AI_BEHAVIOR_DELAY perform(). Override for conditional delays.
handle_async	Checks if we're running async behavior, and if its finished, returns result flags
perform	Called each tick while the behavior is running. Returns AI_BEHAVIOR_* flags.
perform_async	Override this if you have sleeping behavior, be sure to implement the other async procs in perform()
setup	Called when this behavior first activates on a controller. Return FALSE to abort (returns BT_FAILURE).
start_async	Marks that async behavior has started and runs perform_async
tick	ai behavior tick. Runs setup() once on first activation, then perform() each tick. Respects per-controller cooldowns set by AI_BEHAVIOR_DELAY. Returns BT_SUCCESS / BT_FAILURE on completion, BT_RUNNING while active.

Var Details

var
async_finished

TRUE once async finished and via finish_async

var
async_result_flags

AI_BEHAVIOR_* flags that came out of async perform

var
async_running

TRUE while an async perform kicked off by start_async() is going

var
behavior_flags

Flags for extra behavior (see AI_BEHAVIOR_* defines)

var
failed_last_perform

TRUE when the last perform() failed and we are waiting out next_perform_time to say we failed

var
next_perform_time

world.time when perform() may next be called.

var
running

TRUE after setup() has been called and before finish_action() completes.

var
time_between_perform

Cooldown between perform() calls; do not read directly use get_cooldown()

Proc Details

proc
async_still_valid
()

Call from an async behavior after its sleeping call, before committing side effects. FALSE means the behavior was aborted/reset mid-flight bail out without side effects.

proc
finish_action
(/datum/ai_controller/controller, succeeded)

Called when the behavior finishes (succeeded or failed). Subtypes should call ..().

proc
finish_async
(result_flags)

Call from an async behavior to commit its result. No-op if the behavior was aborted mid-flight.

proc
get_cooldown
(/datum/ai_controller/cooldown_for)

Returns the cooldown to apply after a AI_BEHAVIOR_DELAY perform(). Override for conditional delays.

proc
handle_async
()

Checks if we're running async behavior, and if its finished, returns result flags

proc
perform
(seconds_per_tick, /datum/ai_controller/controller)

Called each tick while the behavior is running. Returns AI_BEHAVIOR_* flags.

proc
perform_async
(/datum/ai_controller/controller)

Override this if you have sleeping behavior, be sure to implement the other async procs in perform()

proc
setup
(/datum/ai_controller/controller)

Called when this behavior first activates on a controller. Return FALSE to abort (returns BT_FAILURE).

proc
start_async
()

Marks that async behavior has started and runs perform_async

↑
tick
(/datum/ai_controller/controller, seconds_per_tick)

ai behavior tick. Runs setup() once on first activation, then perform() each tick. Respects per-controller cooldowns set by AI_BEHAVIOR_DELAY. Returns BT_SUCCESS / BT_FAILURE on completion, BT_RUNNING while active.

ai_behavior /datum/bt_node/ai_behavior

Vars

Procs

Var Details

var async_finished

var async_result_flags

var async_running

var behavior_flags

var failed_last_perform

var next_perform_time

var running

var time_between_perform

Proc Details

proc async_still_valid()

proc finish_action(/datum/ai_controller/controller, succeeded)

proc finish_async(result_flags)

proc get_cooldown(/datum/ai_controller/cooldown_for)

proc handle_async()

proc perform(seconds_per_tick, /datum/ai_controller/controller)

proc perform_async(/datum/ai_controller/controller)

proc setup(/datum/ai_controller/controller)

proc start_async()

↑tick(/datum/ai_controller/controller, seconds_per_tick)