critter

Vars
_ai_patience_count	INTERNAL used for mob ai retaliation patience counting
ai_attack_count	Counts the number of attacks this critter has performed without using an ability
ai_attacks_neutral	Whether or not we attack mobs with the neutral faction flag
ai_attacks_per_ability	The number of basic attacks this critter will perform in between using abilities
ai_retaliate_patience	If the mob has an ai, and ai_retaliates is TRUE, how many attacks should we endure before attacking back?
ai_retaliate_persistence	If the mob has an ai, and is currently retaliating against being attacked, how long should we do that for? (deciseconds) Special values: RETALIATE_ONCE = Attack once, RETALIATE_UNTIL_INCAP = Attack until the target is incapacitated, RETALIATE_UNTIL_DEAD = Attck until the target is dead
ai_retaliates	If the mob has an ai, turn this to TRUE if you want it to fight back upon being attacked
butcherer	The mob who is butchering this critter
last_hibernation_wake_tick	time when mob last awoke from hibernation
registered_area	area where the mob ai is registered when hibernating
Procs
butcher	Creates meat and a brain named after the mob containing reagents. Both can be skipped to allow custom butchering at the mob level
can_critter_attack	Used for generic critter mobAI - returns TRUE when the mob is able to attack. For handling cooldowns, or other attack blocking conditions.
can_critter_eat	Used for generic critter mobAI - returns TRUE when the mob is able to eat. For handling cooldowns, or other eat blocking conditions.
can_critter_scavenge	Used for generic critter mobAI - returns TRUE when the mob is able to scavenge. For handling cooldowns, or other scavenge blocking conditions.
critter_ability_attack	How the critter should use abilities, return TRUE to indicate ability usage success
critter_attack	Used for generic critter mobAI - override if your critter needs special attack behaviour. If you need super special attack behaviour, you'll want to create your own attack aiTask
critter_basic_attack	How the critter should attack normally
critter_eat	Used for generic critter mobAI - override if your critter needs additional behaviour for eating
critter_range_attack	How the critter should attack from range (Only applicable for ranged limbs)
critter_retaliate	Used for generic critter mobAI - override if you need special retailation behaviour
critter_scavenge	Used for generic critter mobAI - override if your critter needs special scavenge behaviour. If you need super special attack behaviour, you'll want to create your own attack aiTask
modify_health	admin varediting proc
seek_food_target	Used for generic critter mobAI - targets returned from this proc will be chased and eaten. Return a list of potential targets, one will be picked based on distance.
seek_scavenge_target	Used for generic critter mobAI - targets returned from this proc will be chased and scavenged. Return a list of potential targets, one will be picked based on distance.
seek_target	Used for generic critter mobAI - targets returned from this proc will be chased and attacked. Return a list of potential targets, one will be picked based on distance.
should_critter_retaliate	Used for generic critter mobAI - returns TRUE when the mob should retaliate to this attack. Only used if ai_retaliates = TRUE
updateStatusUi	updates status effects on the owner's hud
wake_from_hibernation	enables mob ai that was disabled by a hibernation task

Var Details

var
_ai_patience_count
–

INTERNAL used for mob ai retaliation patience counting

var
ai_attack_count
–

Counts the number of attacks this critter has performed without using an ability

var
ai_attacks_neutral
–

Whether or not we attack mobs with the neutral faction flag

var
ai_attacks_per_ability
–

The number of basic attacks this critter will perform in between using abilities

var
ai_retaliate_patience
–

If the mob has an ai, and ai_retaliates is TRUE, how many attacks should we endure before attacking back?

var
ai_retaliate_persistence
–

If the mob has an ai, and is currently retaliating against being attacked, how long should we do that for? (deciseconds) Special values: RETALIATE_ONCE = Attack once, RETALIATE_UNTIL_INCAP = Attack until the target is incapacitated, RETALIATE_UNTIL_DEAD = Attck until the target is dead

var
ai_retaliates
–

If the mob has an ai, turn this to TRUE if you want it to fight back upon being attacked

var
butcherer
– /mob

The mob who is butchering this critter

var
last_hibernation_wake_tick
–

time when mob last awoke from hibernation

var
registered_area
– /area

area where the mob ai is registered when hibernating

Proc Details

proc
butcher
(/mob/M, drop_brain, drop_meat)

Creates meat and a brain named after the mob containing reagents. Both can be skipped to allow custom butchering at the mob level

proc
can_critter_attack
()

Used for generic critter mobAI - returns TRUE when the mob is able to attack. For handling cooldowns, or other attack blocking conditions.

proc
can_critter_eat
()

Used for generic critter mobAI - returns TRUE when the mob is able to eat. For handling cooldowns, or other eat blocking conditions.

proc
can_critter_scavenge
()

Used for generic critter mobAI - returns TRUE when the mob is able to scavenge. For handling cooldowns, or other scavenge blocking conditions.

proc
critter_ability_attack
(/mob/target)

How the critter should use abilities, return TRUE to indicate ability usage success

proc
critter_attack
(/mob/target)

Used for generic critter mobAI - override if your critter needs special attack behaviour. If you need super special attack behaviour, you'll want to create your own attack aiTask

proc
critter_basic_attack
(/mob/target)

How the critter should attack normally

proc
critter_eat
(/obj/item/target)

Used for generic critter mobAI - override if your critter needs additional behaviour for eating

proc
critter_range_attack
(/mob/target)

How the critter should attack from range (Only applicable for ranged limbs)

proc
critter_retaliate
(/mob/target)

Used for generic critter mobAI - override if you need special retailation behaviour

proc
critter_scavenge
(/mob/target)

Used for generic critter mobAI - override if your critter needs special scavenge behaviour. If you need super special attack behaviour, you'll want to create your own attack aiTask

proc
modify_health
()

admin varediting proc

proc
seek_food_target
(range)

Used for generic critter mobAI - targets returned from this proc will be chased and eaten. Return a list of potential targets, one will be picked based on distance.

proc
seek_scavenge_target
(range)

Used for generic critter mobAI - targets returned from this proc will be chased and scavenged. Return a list of potential targets, one will be picked based on distance.

proc
seek_target
(range)

Used for generic critter mobAI - targets returned from this proc will be chased and attacked. Return a list of potential targets, one will be picked based on distance.

proc
should_critter_retaliate
(/mob/attcker, /obj/attcked_with)

Used for generic critter mobAI - returns TRUE when the mob should retaliate to this attack. Only used if ai_retaliates = TRUE

↑
updateStatusUi
()

updates status effects on the owner's hud

proc
wake_from_hibernation
()

enables mob ai that was disabled by a hibernation task

critter /mob/living/critter

Vars

Procs

Var Details

var _ai_patience_count –

var ai_attack_count –

var ai_attacks_neutral –

var ai_attacks_per_ability –

var ai_retaliate_patience –

var ai_retaliate_persistence –

var ai_retaliates –

var butcherer – /mob

var last_hibernation_wake_tick –

var registered_area – /area

Proc Details

proc butcher(/mob/M, drop_brain, drop_meat)

proc can_critter_attack()

proc can_critter_eat()

proc can_critter_scavenge()

proc critter_ability_attack(/mob/target)

proc critter_attack(/mob/target)

proc critter_basic_attack(/mob/target)

proc critter_eat(/obj/item/target)

proc critter_range_attack(/mob/target)

proc critter_retaliate(/mob/target)

proc critter_scavenge(/mob/target)

proc modify_health()

proc seek_food_target(range)

proc seek_scavenge_target(range)

proc seek_target(range)

proc should_critter_retaliate(/mob/attcker, /obj/attcked_with)

↑updateStatusUi()

proc wake_from_hibernation()