ai_behavior

Vars
anti_stuck_timer	When this timer is up, we force a change of node to ensure that the ai will never stay stuck trying to go to a specific node
atom_to_walk_to	What atom is the ai moving to
base_action	The standard ation of the AI, aka what it should do at the init or when going back to "normal" behavior
combat_target	The atom we want to attack at range, separate as we might not be moving in regards to it
current_action	What the ai is doing right now
current_node	Current node to use for calculating action states: this is the mob's node
escort_goal	Whether the goal node is specifically for an escort target
escorted_atom	What we will escort
goal_node	The node goal of this ai
goal_nodes	A list of nodes the ai should go to in order to go to goal_node
identifier	An identifier associated with this behavior, used for accessing specific values of a node's weights
interact_target	An atom we want to interact with, such as picking it up
is_offered_on_creation	If the mob attached to the ai is offered on xeno creation
lower_engage_dist	Range to stay from a hostile target. Inner range
lower_maintain_dist	How far should we stay away from atom_to_walk_to. Inner range
minimum_health	Minimum health percentage before the ai tries to run away
mob_parent	Ref to the parent associated with this mind
registered_for_move	Are we already registered for normal pathfinding
registered_for_node_pathfinding	Are we waiting for advanced pathfinding
sidestep_prob	Prob chance of sidestepping (left or right) when distance maintained with target
target_distance	How far will we look for targets
turfs_in_path	A list of turfs the ai should go in order to get to atom_to_walk_to
upper_engage_dist	Range to stay from a hostile target. Outer range
upper_maintain_dist	How far should we stay away from atom_to_walk_to. Outer range
weak_escort	Should we lose the escorted atom if we change action
Procs
ai_complete_move	Makes a move in a given direction
ai_do_move	Tries to move the ai toward its atom_to_walk_to
ask_for_pathfinding	Register on advanced pathfinding subsytem to get a tile pathfinding
change_action	Cleanup old state vars, start the movement towards our new target
clean_escorted_atom	clean the escorted atom var to avoid harddels
clean_goal_node	Clean the goal node
cleanup_current_action	Cleans up signals related to the action and element(s)
cleanup_signals	Clean every signal on the ai_behavior
deal_with_obstacle	Signal handler when the ai is blocked by an obstacle
do_unset_target	Unsets a target from any target vars its in
find_closest_node	Finds the closest node to an atom
find_next_dirs	Find our movement options
finished_node_move	We finished moving to a node, let's pick a random nearby one to travel to
finished_path_move	Signal handler when we reached our current tile goal
get_atom_to_escort	Finds the most suitable thing to escort
global_set_escorted_atom	Change atom to walk to if the order comes from a corresponding commander
late_initialize	Set behaviour to base behavior
look_for_new_state	Check if we need to adopt a new state
look_for_next_node	Try to find a node to go to. If ignore_current_node is true, we will just find the closest current_node, and not the current_node best adjacent node
look_for_node_path	Look for the a* node path to get to goal_node
look_for_tile_path	Look for the a* tile path to get to atom_to_walk_to
scheduled_move	Move the ai and schedule the next move
set_agressivity	Set the target distance to be normal (initial) or very low (almost passive)
set_atom_to_walk_to	Sets our direct movement target
set_combat_target	Sets our active combat target
set_current_node	Set the current node to next_node
set_escort	Finds and sets the most suitable escort candidate, if possible
set_escorted_atom	Set the escorted atom.
set_goal_node	Set the goal node
set_interact_target	Sets an interaction target
should_hold	Returns true if the mob should not move for some reason
start_ai	Register ai behaviours
state_process	Any state specific process behavior
unset_target	Sig handler for unsetting a target

Var Details

var
anti_stuck_timer
–

When this timer is up, we force a change of node to ensure that the ai will never stay stuck trying to go to a specific node

var
atom_to_walk_to
– /atom

What atom is the ai moving to

var
base_action
–

The standard ation of the AI, aka what it should do at the init or when going back to "normal" behavior

var
combat_target
– /atom

The atom we want to attack at range, separate as we might not be moving in regards to it

var
current_action
–

What the ai is doing right now

var
current_node
– /obj/effect/ai_node

Current node to use for calculating action states: this is the mob's node

var
escort_goal
–

Whether the goal node is specifically for an escort target

var
escorted_atom
– /atom

What we will escort

var
goal_node
– /obj/effect/ai_node

The node goal of this ai

var
goal_nodes
– /list/obj/effect/ai_node

A list of nodes the ai should go to in order to go to goal_node

var
identifier
–

An identifier associated with this behavior, used for accessing specific values of a node's weights

var
interact_target
– /atom

An atom we want to interact with, such as picking it up

var
is_offered_on_creation
–

If the mob attached to the ai is offered on xeno creation

var
lower_engage_dist
–

Range to stay from a hostile target. Inner range

var
lower_maintain_dist
–

How far should we stay away from atom_to_walk_to. Inner range

var
minimum_health
–

Minimum health percentage before the ai tries to run away

var
mob_parent
– /mob

Ref to the parent associated with this mind

var
registered_for_move
–

Are we already registered for normal pathfinding

var
registered_for_node_pathfinding
–

Are we waiting for advanced pathfinding

var
sidestep_prob
–

Prob chance of sidestepping (left or right) when distance maintained with target

var
target_distance
–

How far will we look for targets

var
turfs_in_path
– /list/turf

A list of turfs the ai should go in order to get to atom_to_walk_to

var
upper_engage_dist
–

Range to stay from a hostile target. Outer range

var
upper_maintain_dist
–

How far should we stay away from atom_to_walk_to. Outer range

var
weak_escort
–

Should we lose the escorted atom if we change action

Proc Details

proc
ai_complete_move
(move_dir, try_sidestep)

Makes a move in a given direction

proc
ai_do_move
()

Tries to move the ai toward its atom_to_walk_to

proc
ask_for_pathfinding
()

proc
change_action
(next_action, /atom/next_target, /list/special_distance_to_maintain)

Cleanup old state vars, start the movement towards our new target

proc
clean_escorted_atom
()

clean the escorted atom var to avoid harddels

proc
clean_goal_node
()

Clean the goal node

proc
cleanup_current_action
(next_action)

Cleans up signals related to the action and element(s)

proc
cleanup_signals
()

Clean every signal on the ai_behavior

proc
deal_with_obstacle
(/datum/source, direction)

Signal handler when the ai is blocked by an obstacle

proc
do_unset_target
(/atom/old_target, need_new_state, need_new_escort)

Unsets a target from any target vars its in

proc
find_closest_node
(/atom/target, avoid_node)

Finds the closest node to an atom

proc
find_next_dirs
()

Find our movement options

proc
finished_node_move
()

We finished moving to a node, let's pick a random nearby one to travel to

proc
finished_path_move
()

Signal handler when we reached our current tile goal

proc
get_atom_to_escort
()

Finds the most suitable thing to escort

proc
global_set_escorted_atom
(/datum/source, /atom/atom_to_escort)

Change atom to walk to if the order comes from a corresponding commander

proc
late_initialize
()

Set behaviour to base behavior

proc
look_for_new_state
()

Check if we need to adopt a new state

proc
look_for_next_node
(ignore_current_node, should_reset_goal_nodes)

Try to find a node to go to. If ignore_current_node is true, we will just find the closest current_node, and not the current_node best adjacent node

proc
look_for_node_path
()

Look for the a* node path to get to goal_node

proc
look_for_tile_path
()

Look for the a* tile path to get to atom_to_walk_to

proc
scheduled_move
()

Move the ai and schedule the next move

proc
set_agressivity
(/datum/source, should_be_agressive)

Set the target distance to be normal (initial) or very low (almost passive)

proc
set_atom_to_walk_to
(/atom/new_target)

Sets our direct movement target

proc
set_combat_target
(/atom/new_target)

Sets our active combat target

proc
set_current_node
(/obj/effect/ai_node/next_node)

Set the current node to next_node

proc
set_escort
()

Finds and sets the most suitable escort candidate, if possible

proc
set_escorted_atom
(/datum/source, /atom/atom_to_escort, new_escort_is_weak)

Set the escorted atom.

proc
set_goal_node
(/datum/source, /obj/effect/ai_node/new_goal_node, is_escort_goal)

Set the goal node

proc
set_interact_target
(/atom/new_target)

Sets an interaction target

proc
should_hold
()

Returns true if the mob should not move for some reason

proc
start_ai
()

proc
state_process
()

Any state specific process behavior

proc
unset_target
(/atom/source)

Sig handler for unsetting a target

ai_behavior /datum/ai_behavior

Vars

Procs

Var Details

var anti_stuck_timer –

var atom_to_walk_to – /atom

var base_action –

var combat_target – /atom

var current_action –

var current_node – /obj/effect/ai_node

var escort_goal –

var escorted_atom – /atom

var goal_node – /obj/effect/ai_node

var goal_nodes – /list/obj/effect/ai_node

var identifier –

var interact_target – /atom

var is_offered_on_creation –

var lower_engage_dist –

var lower_maintain_dist –

var minimum_health –

var mob_parent – /mob

var registered_for_move –

var registered_for_node_pathfinding –

var sidestep_prob –

var target_distance –

var turfs_in_path – /list/turf

var upper_engage_dist –

var upper_maintain_dist –

var weak_escort –

Proc Details

proc ai_complete_move(move_dir, try_sidestep)

proc ai_do_move()

proc ask_for_pathfinding()

proc change_action(next_action, /atom/next_target, /list/special_distance_to_maintain)

proc clean_escorted_atom()

proc clean_goal_node()

proc cleanup_current_action(next_action)

proc cleanup_signals()

proc deal_with_obstacle(/datum/source, direction)

proc do_unset_target(/atom/old_target, need_new_state, need_new_escort)

proc find_closest_node(/atom/target, avoid_node)

proc find_next_dirs()

proc finished_node_move()

proc finished_path_move()

proc get_atom_to_escort()

proc global_set_escorted_atom(/datum/source, /atom/atom_to_escort)

proc late_initialize()

proc look_for_new_state()

proc look_for_next_node(ignore_current_node, should_reset_goal_nodes)

proc look_for_node_path()

proc look_for_tile_path()

proc scheduled_move()

proc set_agressivity(/datum/source, should_be_agressive)

proc set_atom_to_walk_to(/atom/new_target)

proc set_combat_target(/atom/new_target)

proc set_current_node(/obj/effect/ai_node/next_node)

proc set_escort()

proc set_escorted_atom(/datum/source, /atom/atom_to_escort, new_escort_is_weak)

proc set_goal_node(/datum/source, /obj/effect/ai_node/new_goal_node, is_escort_goal)

proc set_interact_target(/atom/new_target)

proc should_hold()

proc start_ai()

proc state_process()

proc unset_target(/atom/source)

ai_behavior
/datum/ai_behavior

var
anti_stuck_timer
–

var
atom_to_walk_to
– /atom

var
base_action
–

var
combat_target
– /atom

var
current_action
–

var
current_node
– /obj/effect/ai_node

var
escort_goal
–

var
escorted_atom
– /atom

var
goal_node
– /obj/effect/ai_node

var
goal_nodes
– /list/obj/effect/ai_node

var
identifier
–

var
interact_target
– /atom

var
is_offered_on_creation
–

var
lower_engage_dist
–

var
lower_maintain_dist
–

var
minimum_health
–

var
mob_parent
– /mob

var
registered_for_move
–

var
registered_for_node_pathfinding
–

var
sidestep_prob
–

var
target_distance
–

var
turfs_in_path
– /list/turf

var
upper_engage_dist
–

var
upper_maintain_dist
–

var
weak_escort
–

proc
ai_complete_move
(move_dir, try_sidestep)

proc
ai_do_move
()

proc
ask_for_pathfinding
()

proc
change_action
(next_action, /atom/next_target, /list/special_distance_to_maintain)

proc
clean_escorted_atom
()

proc
clean_goal_node
()

proc
cleanup_current_action
(next_action)

proc
cleanup_signals
()

proc
deal_with_obstacle
(/datum/source, direction)

proc
do_unset_target
(/atom/old_target, need_new_state, need_new_escort)

proc
find_closest_node
(/atom/target, avoid_node)

proc
find_next_dirs
()

proc
finished_node_move
()

proc
finished_path_move
()

proc
get_atom_to_escort
()

proc
global_set_escorted_atom
(/datum/source, /atom/atom_to_escort)

proc
late_initialize
()

proc
look_for_new_state
()

proc
look_for_next_node
(ignore_current_node, should_reset_goal_nodes)

proc
look_for_node_path
()

proc
look_for_tile_path
()

proc
scheduled_move
()

proc
set_agressivity
(/datum/source, should_be_agressive)

proc
set_atom_to_walk_to
(/atom/new_target)

proc
set_combat_target
(/atom/new_target)

proc
set_current_node
(/obj/effect/ai_node/next_node)

proc
set_escort
()

proc
set_escorted_atom
(/datum/source, /atom/atom_to_escort, new_escort_is_weak)

proc
set_goal_node
(/datum/source, /obj/effect/ai_node/new_goal_node, is_escort_goal)

proc
set_interact_target
(/atom/new_target)

proc
should_hold
()

proc
start_ai
()

proc
state_process
()

proc
unset_target
(/atom/source)