/tg/ Station 13 - Modules - TypesVar Details - Proc Details

ai_controller

Vars

ai_movementReference to the movement datum we use. Is a type on initialize but becomes a ref afterwards.
ai_statusCurrent status of AI (OFF/ON)
ai_traitsBitfield of traits for this AI to handle extra behavior
behavior_argsStored arguments for behaviors given during their initial creation
behavior_cooldownsCurrent actions and their respective last time ran as an assoc list.
blackboardThis is a list of variables the AI uses and can be mutated by actions. When an action is performed you pass this list and any relevant keys for the variables it can mutate.
continue_processing_when_clientCan the AI remain in control if there is a client?
current_behaviorsCurrent actions being performed by the AI.
current_movement_targetCurrent movement target of the AI, generally set by decision making.
failed_planning_cooldownCooldown for new plans, to prevent AI from going nuts if it can't think of new plans and looping on end
idle_behaviorThe idle behavior this AI performs when it has no actions.
max_target_distancedistance to give up on target
movement_cooldownCooldown until next movement
movement_delayDelay between movements. This is on the controller so we can keep the movement datum singleton
movement_pathA list for the path we're currently following, if we're using JPS pathing
pathing_attemptsTracks recent pathing attempts, if we fail too many in a row we fail our current plans.
paused_untilAI paused time
pawnThe atom this controller is controlling
planning_subtreesAll subtrees this AI has available, will run them in order, so make sure they're in the order you want them to run. On initialization of this type, it will start as a typepath(s) and get converted to references of ai_subtrees found in SSai_controllers when init_subtrees() is called
repath_cooldownCooldown for JPS movement, how often we're allowed to try making a new path

Procs

PossessPawnProc to move from one pawn to another, this will destroy the target's existing controller.
SelectBehaviorsAre we close enough to engage? This is where you decide what actions are taken by the AI.
TryPossessPawnAbstract proc for initializing the pawn to the new controller
UnpossessPawnProc for deinitializing the pawn to the old controller
able_to_runReturns TRUE if the ai controller can actually run at the moment.
change_ai_movement_typeOverrides the current ai_movement of this controller with a new one
get_accessUse this proc to define how your controller defines what access the pawn has for the sake of pathfinding, likely pointing to whatever ID slot is relevant
init_subtreesLoops over the subtrees in planning_subtrees and looks at the ai_controllers to grab a reference, ENSURE planning_subtrees ARE TYPEPATHS AND NOT INSTANCES/REFERENCES BEFORE EXECUTING THIS
processRuns any actions that are currently running
queue_behaviorCall this to add a behavior to the stack.
replace_planning_subtreesCompletely replaces the planning_subtrees with a new set based on argument provided, list provided must contain specifically typepaths
set_ai_statusThis proc handles changing ai status, and starts/stops processing if required.

Var Details

ai_movement

Reference to the movement datum we use. Is a type on initialize but becomes a ref afterwards.

ai_status

Current status of AI (OFF/ON)

ai_traits

Bitfield of traits for this AI to handle extra behavior

behavior_args

Stored arguments for behaviors given during their initial creation

behavior_cooldowns

Current actions and their respective last time ran as an assoc list.

blackboard

This is a list of variables the AI uses and can be mutated by actions. When an action is performed you pass this list and any relevant keys for the variables it can mutate.

continue_processing_when_client

Can the AI remain in control if there is a client?

current_behaviors

Current actions being performed by the AI.

current_movement_target

Current movement target of the AI, generally set by decision making.

failed_planning_cooldown

Cooldown for new plans, to prevent AI from going nuts if it can't think of new plans and looping on end

idle_behavior

The idle behavior this AI performs when it has no actions.

max_target_distance

distance to give up on target

movement_cooldown

Cooldown until next movement

movement_delay

Delay between movements. This is on the controller so we can keep the movement datum singleton

movement_path

A list for the path we're currently following, if we're using JPS pathing

pathing_attempts

Tracks recent pathing attempts, if we fail too many in a row we fail our current plans.

paused_until

AI paused time

pawn

The atom this controller is controlling

planning_subtrees

All subtrees this AI has available, will run them in order, so make sure they're in the order you want them to run. On initialization of this type, it will start as a typepath(s) and get converted to references of ai_subtrees found in SSai_controllers when init_subtrees() is called

repath_cooldown

Cooldown for JPS movement, how often we're allowed to try making a new path

Proc Details

PossessPawn

Proc to move from one pawn to another, this will destroy the target's existing controller.

SelectBehaviors

Are we close enough to engage? This is where you decide what actions are taken by the AI.

TryPossessPawn

Abstract proc for initializing the pawn to the new controller

UnpossessPawn

Proc for deinitializing the pawn to the old controller

able_to_run

Returns TRUE if the ai controller can actually run at the moment.

change_ai_movement_type

Overrides the current ai_movement of this controller with a new one

get_access

Use this proc to define how your controller defines what access the pawn has for the sake of pathfinding, likely pointing to whatever ID slot is relevant

init_subtrees

Loops over the subtrees in planning_subtrees and looks at the ai_controllers to grab a reference, ENSURE planning_subtrees ARE TYPEPATHS AND NOT INSTANCES/REFERENCES BEFORE EXECUTING THIS

process

Runs any actions that are currently running

queue_behavior

Call this to add a behavior to the stack.

replace_planning_subtrees

Completely replaces the planning_subtrees with a new set based on argument provided, list provided must contain specifically typepaths

set_ai_status

This proc handles changing ai status, and starts/stops processing if required.