ai_holder

Vars
autopilot	If true, the AI won't be deactivated if a client gets attached to the AI's mob.
busy	If true, the ticker will skip processing this mob until this is false. Good for if you need the mob to stay still (e.g. delayed attacking). If you need the mob to be inactive for an extended period of time, consider sleeping the AI instead.
call_distance	How far away calls for help will go for.
cooperative	If true, asks allies to help when fighting something.
faction_friends	List of all mobs inside the faction with ai_holders that have cooperate on, to call for help without using range(). Note that this is only used for sending calls out. Receiving calls doesn't care about this list, only if the mob is in the faction.
holder	The mob this datum is going to control.
holder_required_type	The required mob type of the holder.
intelligence_level	Adjust to make the AI be intentionally dumber, or make it more robust (e.g. dodging grenades).
next_received_help_request	time when the mob can receive a help request from another mob
next_sent_help_request	time when this mob is allowed to call for help
process_flags	Where we're processing, see flag defines.
snapshot	A list used in mass-editing of AI datums, holding a snapshot of the 'before' state
stance	Determines if the mob should be doing a specific thing, e.g. attacking, following, standing around, etc.
Procs
add_attacker	We were attacked by this thing recently
can_see_target	Check if target is visible to us.
check_attacker	Checks to see if an atom attacked us lately
find_target	Step 2, filter down possible targets to things we actually care about.
forget_everything	Resets a lot of 'memory' vars.
get_path	A* now, try to a path to a target
give_target	Step 4, give us our selected target.
go_sleep	Makes this ai holder not get processed. Called automatically when the host mob is killed. Potential future optimization would be to sleep AIs which mobs that are far away from in-round players.
go_wake	Reverses the `go_sleep()` proc. Revived mobs will wake their AI if they have one.
handle_special_strategical	Override this for special things without polluting the main `handle_strategicals()` loop.
handle_special_tactic	Override this for special things without polluting the main `handle_tactics()` loop.
handle_stance_strategical	This is called every two seconds.
handle_stance_tactical	This is called every half a second.
handle_strategicals	'Strategical' processes that are more expensive on the CPU and so don't get run as often as the above proc, such as A* pathfinding or robust targeting.
handle_tactics	'Tactical' processes such as moving a step, meleeing an enemy, firing a projectile, and other fairly cheap actions that need to happen quickly.
handle_wander_movement	Wanders randomly in cardinal directions.
help_requested	What allies receive when someone else is calling for help.
list_targets	Step 1, find out what we can see.
lose_target	'Soft' loss of target. They may still exist, we still have some info about them maybe.
lose_target_position	Resets the last known position to null.
move_once	Take one step along a path
on_attacked	Sets a few vars so mobs that threaten will react faster to an attacker or someone who attacked them before.
pick_target	Step 3, pick among the possible, attackable targets.
react_to_attack	Responds to a hostile action against its mob.
receive_taunt	Causes targeting to prefer targeting the taunter if possible. This generally occurs if more than one option is within striking distance, including the taunter. Otherwise the default filter will prefer the closest target.
remove_attacker	Forgive this attacker
remove_target	'Hard' loss of target. Clean things up and return to idle.
request_help	Requests help in combat from other mobs possessing ai_holders.
set_busy_delay	Set the AI as 'busy' for a specific length of time.
set_stance	For setting the stance WITHOUT processing it
target_filter_closest	Returns the closest target and anything tied with it for distance
target_filter_distance	Targets closer to us than the current one.
track_target_position	Updates the last known position of the target.
walk_path	Walk towards whatever.

Var Details

var
autopilot
–

If true, the AI won't be deactivated if a client gets attached to the AI's mob.

var
busy
–

If true, the ticker will skip processing this mob until this is false. Good for if you need the mob to stay still (e.g. delayed attacking). If you need the mob to be inactive for an extended period of time, consider sleeping the AI instead.

var
call_distance
–

How far away calls for help will go for.

var
cooperative
–

If true, asks allies to help when fighting something.

var
faction_friends
– /list

List of all mobs inside the faction with ai_holders that have cooperate on, to call for help without using range(). Note that this is only used for sending calls out. Receiving calls doesn't care about this list, only if the mob is in the faction.

var
holder
– /mob/living

The mob this datum is going to control.

var
holder_required_type
–

The required mob type of the holder.

var
intelligence_level
–

Adjust to make the AI be intentionally dumber, or make it more robust (e.g. dodging grenades).

var
next_received_help_request
–

time when the mob can receive a help request from another mob

var
next_sent_help_request
–

time when this mob is allowed to call for help

var
process_flags
–

Where we're processing, see flag defines.

var
snapshot
– /list

A list used in mass-editing of AI datums, holding a snapshot of the 'before' state

var
stance
–

Determines if the mob should be doing a specific thing, e.g. attacking, following, standing around, etc.

Proc Details

proc
add_attacker
(/atom/movable/A)

We were attacked by this thing recently

proc
can_see_target
(/atom/movable/target, view_range)

Check if target is visible to us.

proc
check_attacker
(/atom/movable/A)

Checks to see if an atom attacked us lately

proc
find_target
(/list/possible_targets, has_targets_list)

Step 2, filter down possible targets to things we actually care about.

proc
forget_everything
()

Resets a lot of 'memory' vars.

proc
get_path
(/turf/target, get_to, max_distance)

A* now, try to a path to a target

proc
give_target
(new_target, urgent)

Step 4, give us our selected target.

proc
go_sleep
()

Makes this ai holder not get processed. Called automatically when the host mob is killed. Potential future optimization would be to sleep AIs which mobs that are far away from in-round players.

proc
go_wake
()

Reverses the go_sleep() proc. Revived mobs will wake their AI if they have one.

proc
handle_special_strategical
()

Override this for special things without polluting the main handle_strategicals() loop.

proc
handle_special_tactic
()

Override this for special things without polluting the main handle_tactics() loop.

proc
handle_stance_strategical
()

This is called every two seconds.

proc
handle_stance_tactical
()

This is called every half a second.

proc
handle_strategicals
()

'Strategical' processes that are more expensive on the CPU and so don't get run as often as the above proc, such as A* pathfinding or robust targeting.

proc
handle_tactics
()

'Tactical' processes such as moving a step, meleeing an enemy, firing a projectile, and other fairly cheap actions that need to happen quickly.

proc
handle_wander_movement
()

Wanders randomly in cardinal directions.

proc
help_requested
(/mob/living/friend)

What allies receive when someone else is calling for help.

proc
list_targets
()

Step 1, find out what we can see.

proc
lose_target
()

'Soft' loss of target. They may still exist, we still have some info about them maybe.

proc
lose_target_position
()

Resets the last known position to null.

proc
move_once
()

Take one step along a path

proc
on_attacked
(/atom/movable/AM)

Sets a few vars so mobs that threaten will react faster to an attacker or someone who attacked them before.

proc
pick_target
(/list/targets)

Step 3, pick among the possible, attackable targets.

proc
react_to_attack
(/atom/movable/attacker)

Responds to a hostile action against its mob.

proc
receive_taunt
(/atom/movable/taunter, force_target_switch)

Causes targeting to prefer targeting the taunter if possible. This generally occurs if more than one option is within striking distance, including the taunter. Otherwise the default filter will prefer the closest target.

proc
remove_attacker
(/atom/movable/A)

Forgive this attacker

proc
remove_target
()

'Hard' loss of target. Clean things up and return to idle.

proc
request_help
()

Requests help in combat from other mobs possessing ai_holders.

proc
set_busy_delay
(time)

Set the AI as 'busy' for a specific length of time.

proc
set_stance
(new_stance)

For setting the stance WITHOUT processing it

proc
target_filter_closest
(/list/targets)

Returns the closest target and anything tied with it for distance

proc
target_filter_distance
(/list/targets)

Targets closer to us than the current one.

proc
track_target_position
()

Updates the last known position of the target.

proc
walk_path
(/atom/A, get_to)

Walk towards whatever.

ai_holder /datum/ai_holder

Vars

Procs

Var Details

var autopilot –

var busy –

var call_distance –

var cooperative –

var faction_friends – /list

var holder – /mob/living

var holder_required_type –

var intelligence_level –

var next_received_help_request –

var next_sent_help_request –

var process_flags –

var snapshot – /list

var stance –

Proc Details

proc add_attacker(/atom/movable/A)

proc can_see_target(/atom/movable/target, view_range)

proc check_attacker(/atom/movable/A)

proc find_target(/list/possible_targets, has_targets_list)

proc forget_everything()

proc get_path(/turf/target, get_to, max_distance)

proc give_target(new_target, urgent)

proc go_sleep()

proc go_wake()

proc handle_special_strategical()

proc handle_special_tactic()

proc handle_stance_strategical()

proc handle_stance_tactical()

proc handle_strategicals()

proc handle_tactics()

proc handle_wander_movement()

proc help_requested(/mob/living/friend)

proc list_targets()

proc lose_target()

proc lose_target_position()

proc move_once()

proc on_attacked(/atom/movable/AM)

proc pick_target(/list/targets)

proc react_to_attack(/atom/movable/attacker)

proc receive_taunt(/atom/movable/taunter, force_target_switch)

proc remove_attacker(/atom/movable/A)

proc remove_target()

proc request_help()

proc set_busy_delay(time)

proc set_stance(new_stance)

proc target_filter_closest(/list/targets)

proc target_filter_distance(/list/targets)

proc track_target_position()

proc walk_path(/atom/A, get_to)