pet_command

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

Vars
callout_type	Callout that triggers this command
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
hidden	If true, command will not appear in radial menu and can only be accessed through speech
radial_icon	Icon to display in radial menu
radial_icon_state	Icon state to display in radial menu
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
weak_parent	Weak reference to who follows this command
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
provide_radial_data	Provide information about how to display this command in a radial menu
remove_friend	Stop listening to a guy
respond_to_callout	Respond to a callout
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
valid_callout_target	Does this callout with this target trigger this command?
waive_automute	Stop the automute from triggering for commands (unless the spoken text is suspiciously longer than the command)

Var Details

var
callout_type
–

Callout that triggers this command

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
hidden
–

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

var
radial_icon
– /icon

Icon to display in radial menu

var
radial_icon_state
–

Icon state to display in radial menu

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
weak_parent
– /datum/weakref

Weak reference to who follows this command

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/pointed_atom)

Target the pointed atom for actions

proc
provide_radial_data
()

Provide information about how to display this command in a radial menu

proc
remove_friend
(/mob/living/unfriended)

Stop listening to a guy

proc
respond_to_callout
(/mob/living/caller, /datum/callout_option/callout, /atom/target)

Respond to a callout

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)

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)

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

proc
valid_callout_target
(/mob/living/caller, /datum/callout_option/callout, /atom/target)

Does this callout with this target trigger this command?

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 callout_type –

var command_desc –

var command_feedback –

var command_name –

var hidden –

var radial_icon – /icon

var radial_icon_state –

var sense_radius –

var speech_commands – /list

var weak_parent – /datum/weakref

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/pointed_atom)

proc provide_radial_data()

proc remove_friend(/mob/living/unfriended)

proc respond_to_callout(/mob/living/caller, /datum/callout_option/callout, /atom/target)

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

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

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

proc try_activate_command(/mob/living/commander)

proc valid_callout_target(/mob/living/caller, /datum/callout_option/callout, /atom/target)

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