pet_command

Set some AI blackboard commands in response to receiving instructions This is abstract and should be extended for actual behaviour

Vars
command_desc	Description to display in radial menu
command_feedback	Shown above the mob's head when it hears you
command_name	Unique name used for radial selection, should not be shared with other commands on one mob
command_regex	The regex for finding our commands in speech
hidden	If true, command will not appear in radial menu and can only be accessed through speech
parent_uid	UID of who follows this command
pointed_reaction	our pointed reaction we play
requires_pointing	does this pet command need a point to activate?
sense_radius	How close a mob needs to be to a target to respond to a command
speech_commands	Speech strings to listen out for
targeting_strategy_key	Blackboard key for targeting strategy, this is likely going to need it
Procs
add_new_friend	Register a new guy we want to listen to
execute_action	Execute an AI action on the provided controller, what we should actually do when this command is active. This should basically always be called from a planning subtree which passes its own controller. Return SUBTREE_RETURN_FINISH_PLANNING to pass that instruction on to the controller, or don't if you don't want that.
find_command_in_text	Returns true if we find any of our spoken commands in the text. if check_verbosity is true, skip the match if there spoken_text is way longer than the match
look_for_target	Target the pointed atom for actions
on_target_set	Target the pointed atom for actions
remove_friend	Stop listening to a guy
respond_to_command	Respond to something that one of our friends has asked us to do
set_command_active	Activate the command, extend to add visible messages and the like
set_command_target	Store the target for the AI blackboard
try_activate_command	Apply a command state if conditions are right, return command if successful
waive_automute	Stop the automute from triggering for commands (unless the spoken text is suspiciously longer than the command)

Var Details

var
command_desc

Description to display in radial menu

var
command_feedback

Shown above the mob's head when it hears you

var
command_name

Unique name used for radial selection, should not be shared with other commands on one mob

var
command_regex
– /regex

The regex for finding our commands in speech

var
hidden

If true, command will not appear in radial menu and can only be accessed through speech

var
parent_uid

UID of who follows this command

var
pointed_reaction

our pointed reaction we play

var
requires_pointing

does this pet command need a point to activate?

var
sense_radius

How close a mob needs to be to a target to respond to a command

var
speech_commands
– /list

Speech strings to listen out for

var
targeting_strategy_key

Blackboard key for targeting strategy, this is likely going to need it

Proc Details

proc
add_new_friend
(/mob/living/tamer)

proc
execute_action
(/datum/ai_controller/controller)

Execute an AI action on the provided controller, what we should actually do when this command is active. This should basically always be called from a planning subtree which passes its own controller. Return SUBTREE_RETURN_FINISH_PLANNING to pass that instruction on to the controller, or don't if you don't want that.

proc
find_command_in_text
(spoken_text, check_verbosity)

Returns true if we find any of our spoken commands in the text. if check_verbosity is true, skip the match if there spoken_text is way longer than the match

proc
look_for_target
(/mob/living/friend, /atom/potential_target)

Target the pointed atom for actions

proc
on_target_set
(/mob/living/friend, /atom/potential_target)

Target the pointed atom for actions

proc
remove_friend
(/mob/living/unfriended)

Stop listening to a guy

proc
respond_to_command
(/mob/living/speaker, speech_args)

Respond to something that one of our friends has asked us to do

proc
set_command_active
(/mob/living/parent, /mob/living/commander, radial_command)

Activate the command, extend to add visible messages and the like

proc
set_command_target
(/mob/living/parent, /atom/target)

Store the target for the AI blackboard

proc
try_activate_command
(/mob/living/commander, radial_command)

Apply a command state if conditions are right, return command if successful

proc
waive_automute
(/mob/living/speaker, /client/client, last_message, mute_type)

Stop the automute from triggering for commands (unless the spoken text is suspiciously longer than the command)

Pet Command /datum/pet_command

Vars

Procs

Var Details

var command_desc

var command_feedback

var command_name

var command_regex – /regex

var hidden

var parent_uid

var pointed_reaction

var requires_pointing

var sense_radius

var speech_commands – /list

var targeting_strategy_key

Proc Details

proc add_new_friend(/mob/living/tamer)

proc execute_action(/datum/ai_controller/controller)

proc find_command_in_text(spoken_text, check_verbosity)

proc look_for_target(/mob/living/friend, /atom/potential_target)

proc on_target_set(/mob/living/friend, /atom/potential_target)

proc remove_friend(/mob/living/unfriended)

proc respond_to_command(/mob/living/speaker, speech_args)

proc set_command_active(/mob/living/parent, /mob/living/commander, radial_command)

proc set_command_target(/mob/living/parent, /atom/target)

proc try_activate_command(/mob/living/commander, radial_command)

proc waive_automute(/mob/living/speaker, /client/client, last_message, mute_type)