/datum/speech_module_tree

Speech module tree datums handle applying the effects of speech prefix, modifier, and output modules to say message datums sent by the parent atom. All say message datums will be processed here prior to being passed to the appropriate say channel by a speech output module.

Vars
auxiliary_trees	A list of all auxiliary speech module trees with this speech module tree registered as a target.
persistent_speech_modifiers_by_id	An associative list of speech modifier modules that overide say channel modifier preferences, indexed by the module ID.
postmodifier_speech_prefixes_by_prefix_id	An associative list of speech prefix modules that should be processed after modifiers, indexed by the prefix ID or IDs.
premodifier_speech_prefixes_by_prefix_id	An associative list of speech prefix modules that should be processed before modifiers, indexed by the prefix ID or IDs.
secondary_parents	A list of all atoms that list this speech module tree as their speech tree, despite not being the true parent.
speaker_origin	The atom that should act as the origin point for sending messages from this speech module tree.
speaker_parent	The owner of this speech module tree.
speech_modifier_ids_with_subcount	An associative list of speech modifier module subscription counts, indexed by the module ID.
speech_modifiers_by_id	An associative list of speech modifier modules, indexed by the module ID.
speech_output_ids_with_subcount	An associative list of speech output module subscription counts, indexed by the module ID.
speech_outputs_by_channel	An associative list of speech output modules, indexed by the module channel. Additionally, each sublist of modules is sorted by priority.
speech_outputs_by_id	An associative list of speech output modules, indexed by the module ID.
speech_prefix_ids_with_subcount	An associative list of speech prefix module subscription counts, indexed by the module ID.
speech_prefixes	A list of speech prefix modules, sorted by priority.
speech_prefixes_by_id	An associative list of speech prefix modules, indexed by the module ID.
Procs
GetAllPrefixes	Returns all speech prefix modules on this speech tree.
GetModifierByID	Returns the speech modifier module that matches the specified ID.
GetOutputByID	Returns the speech output module that matches the specified ID.
GetOutputsByChannel	Returns a list of speech output modules that output to the specified channel.
GetPrefixByID	Returns the speech prefix module that matches the specified ID.
RemoveSpeechModifier	Removes a speech modifier module from the tree. Returns TRUE on success, FALSE on failure.
RemoveSpeechOutput	Removes a speech output module from the tree. Returns TRUE on success, FALSE on failure.
RemoveSpeechPrefix	Removes a speech prefix module from the tree. Returns TRUE on success, FALSE on failure.
_AddSpeechModifier	Adds a new speech modifier module to the tree. Returns a reference to the new modifier module on success.
_AddSpeechOutput	Adds a new speech output module to the tree. Returns a reference to the new output module on success.
_AddSpeechPrefix	Adds a new speech prefix module to the tree. Returns a reference to the new prefix module on success.
migrate_speech_tree	Migrates this speech module tree to a new speaker parent and origin.
process	Process the message, applying the effects of each accent, speech, and output module.
process_prefix	Attempt to locate an applicable prefix module from the provided prefix module cache, and apply its affects to a say message.
update_speaker_origin	Update this speech module tree's speaker origin. This will cause spoken messages to appear to originate fom the new speaker origin.

Var Details

var
auxiliary_trees
– /list/datum/speech_module_tree/auxiliary

A list of all auxiliary speech module trees with this speech module tree registered as a target.

var
persistent_speech_modifiers_by_id
– /list/datum/speech_module/modifier

An associative list of speech modifier modules that overide say channel modifier preferences, indexed by the module ID.

var
postmodifier_speech_prefixes_by_prefix_id
– /list/datum/speech_module/prefix/postmodifier

An associative list of speech prefix modules that should be processed after modifiers, indexed by the prefix ID or IDs.

var
premodifier_speech_prefixes_by_prefix_id
– /list/datum/speech_module/prefix/premodifier

An associative list of speech prefix modules that should be processed before modifiers, indexed by the prefix ID or IDs.

var
secondary_parents
– /list/atom

A list of all atoms that list this speech module tree as their speech tree, despite not being the true parent.

var
speaker_origin
– /atom

The atom that should act as the origin point for sending messages from this speech module tree.

var
speaker_parent
– /atom

The owner of this speech module tree.

var
speech_modifier_ids_with_subcount
– /list

An associative list of speech modifier module subscription counts, indexed by the module ID.

var
speech_modifiers_by_id
– /list/datum/speech_module/modifier

An associative list of speech modifier modules, indexed by the module ID.

var
speech_output_ids_with_subcount
– /list

An associative list of speech output module subscription counts, indexed by the module ID.

var
speech_outputs_by_channel
– /list/datum/speech_module/output

An associative list of speech output modules, indexed by the module channel. Additionally, each sublist of modules is sorted by priority.

var
speech_outputs_by_id
– /list/datum/speech_module/output

An associative list of speech output modules, indexed by the module ID.

var
speech_prefix_ids_with_subcount
– /list

An associative list of speech prefix module subscription counts, indexed by the module ID.

var
speech_prefixes
– /list/datum/speech_module/prefix

A list of speech prefix modules, sorted by priority.

var
speech_prefixes_by_id
– /list/datum/speech_module/prefix

An associative list of speech prefix modules, indexed by the module ID.

Proc Details

proc
GetAllPrefixes
()

Returns all speech prefix modules on this speech tree.

proc
GetModifierByID
(modifier_id)

Returns the speech modifier module that matches the specified ID.

proc
GetOutputByID
(output_id, subchannel)

Returns the speech output module that matches the specified ID.

proc
GetOutputsByChannel
(channel_id)

Returns a list of speech output modules that output to the specified channel.

proc
GetPrefixByID
(prefix_id)

Returns the speech prefix module that matches the specified ID.

proc
RemoveSpeechModifier
(modifier_id, count)

Removes a speech modifier module from the tree. Returns TRUE on success, FALSE on failure.

proc
RemoveSpeechOutput
(output_id, subchannel, count)

Removes a speech output module from the tree. Returns TRUE on success, FALSE on failure.

proc
RemoveSpeechPrefix
(prefix_id, count)

Removes a speech prefix module from the tree. Returns TRUE on success, FALSE on failure.

proc
_AddSpeechModifier
(modifier_id, /list/arguments, count)

Adds a new speech modifier module to the tree. Returns a reference to the new modifier module on success.

proc
_AddSpeechOutput
(output_id, /list/arguments, count)

Adds a new speech output module to the tree. Returns a reference to the new output module on success.

proc
_AddSpeechPrefix
(prefix_id, /list/arguments, count)

Adds a new speech prefix module to the tree. Returns a reference to the new prefix module on success.

proc
migrate_speech_tree
(/atom/new_parent, /atom/new_origin, preserve_old_reference)

Migrates this speech module tree to a new speaker parent and origin.

proc
process
(/datum/say_message/message)

Process the message, applying the effects of each accent, speech, and output module.

proc
process_prefix
(/datum/say_message/message, /list/datum/speech_module/prefix/module_cache)

Attempt to locate an applicable prefix module from the provided prefix module cache, and apply its affects to a say message.

proc
update_speaker_origin
(/atom/new_origin)

Update this speech module tree's speaker origin. This will cause spoken messages to appear to originate fom the new speaker origin.

/datum/speech_module_tree

Vars

Procs

Var Details

var auxiliary_trees – /list/datum/speech_module_tree/auxiliary

var persistent_speech_modifiers_by_id – /list/datum/speech_module/modifier

var postmodifier_speech_prefixes_by_prefix_id – /list/datum/speech_module/prefix/postmodifier

var premodifier_speech_prefixes_by_prefix_id – /list/datum/speech_module/prefix/premodifier

var secondary_parents – /list/atom

var speaker_origin – /atom

var speaker_parent – /atom

var speech_modifier_ids_with_subcount – /list

var speech_modifiers_by_id – /list/datum/speech_module/modifier

var speech_output_ids_with_subcount – /list

var speech_outputs_by_channel – /list/datum/speech_module/output

var speech_outputs_by_id – /list/datum/speech_module/output

var speech_prefix_ids_with_subcount – /list

var speech_prefixes – /list/datum/speech_module/prefix

var speech_prefixes_by_id – /list/datum/speech_module/prefix

Proc Details

proc GetAllPrefixes()

proc GetModifierByID(modifier_id)

proc GetOutputByID(output_id, subchannel)

proc GetOutputsByChannel(channel_id)

proc GetPrefixByID(prefix_id)

proc RemoveSpeechModifier(modifier_id, count)

proc RemoveSpeechOutput(output_id, subchannel, count)

proc RemoveSpeechPrefix(prefix_id, count)

proc _AddSpeechModifier(modifier_id, /list/arguments, count)

proc _AddSpeechOutput(output_id, /list/arguments, count)

proc _AddSpeechPrefix(prefix_id, /list/arguments, count)

proc migrate_speech_tree(/atom/new_parent, /atom/new_origin, preserve_old_reference)

proc process(/datum/say_message/message)

proc process_prefix(/datum/say_message/message, /list/datum/speech_module/prefix/module_cache)

proc update_speaker_origin(/atom/new_origin)