/datum/listen_module_tree

Listen module tree datums handle applying the effects of languages and listen modifier modules to say message datums received by any listen input modules registered to itself. Processed messages are then stored in the message buffer before being sent to listen effect modules.

Vars
auxiliary_trees	A list of all auxiliary listen module trees with this listen module tree registered as a target.
enable_requests	The number of concurrent requests for this listen module tree to be enabled.
enabled	If disabled, this listen module tree will not receive any messages.
known_language_ids_with_subcount	An associative list of language datum subscription counts, indexed by the language ID.
known_languages_by_id	An associative list of language datums, indexed by the language ID.
listen_control_ids_with_subcount	An associative list of listen control module subscription counts, indexed by the module ID.
listen_controls_by_id	An associative list of listen control modules, indexed by the module ID.
listen_effect_ids_with_subcount	An associative list of listen effect module subscription counts, indexed by the module ID.
listen_effects_by_id	An associative list of listen effect modules, indexed by the module ID.
listen_input_ids_with_subcount	An associative list of listen input module subscription counts, indexed by the module ID.
listen_inputs_by_channel	An associative list of listen input modules, indexed by the module channel.
listen_inputs_by_id	An associative list of listen input modules, indexed by the module ID.
listen_modifier_ids_with_subcount	An associative list of listen modifier module subscription counts, indexed by the module ID.
listen_modifiers_by_id	An associative list of listen modifier modules, indexed by the module ID.
listener_origin	The atom that should act as the origin point for listening to messages.
listener_parent	The atom that should receive messages sent to this listen module tree.
message_buffer	A temporary buffer of all received messages that are to be outputted to the parent when the buffer is flushed.
message_exporting_trees	A list of all listen module trees that this listen module tree buffers processed messages from.
message_importing_trees	A list of all listen module trees that buffer messages processed by this listen module tree.
persistent_listen_modifiers_by_id	An associative list of listen modifier modules that overide say channel modifier preferences, indexed by the module ID.
secondary_parents	A list of all atoms that list this listen module tree as their listen tree, despite not being the true parent.
signal_recipients	An associative list of all signal recipients that may cause the message buffer to flush.
understands_all_languages	Whether this listen module tree is capable of understanding all languages.
Procs
AddKnownLanguage	Adds a known language to this listen tree. Known languages allow messages to be understood. Returns TRUE on success, FALSE on failure.
AddLanguageAllSubcount	Adds a count from the `LANGUAGE_ALL` subcount, and enables `understands_all_languages`.
GetControlByID	Returns the listen control module that matches the specified ID.
GetEffectByID	Returns the listen effect module that matches the specified ID.
GetInputByID	Returns the listen input module that matches the specified ID.
GetInputsByChannel	Returns a list of listen input modules that receive from the specified channel.
GetModifierByID	Returns the listen modifier module that matches the specified ID.
RemoveKnownLanguage	Removes a known language from this listen tree. Known languages allow messages to be understood. Returns TRUE on success, FALSE on failure.
RemoveLanguageAllSubcount	Removes a count from the `LANGUAGE_ALL` subcount, and disables `understands_all_languages` if no counts remain.
RemoveListenControl	Removes a listen control module from the tree. Returns TRUE on success, FALSE on failure.
RemoveListenEffect	Removes a listen effect module from the tree. Returns TRUE on success, FALSE on failure.
RemoveListenInput	Removes a listen input module from the tree. Returns TRUE on success, FALSE on failure.
RemoveListenModifier	Removes a listen modifier module from the tree. Returns TRUE on success, FALSE on failure.
_AddListenControl	Adds a new listen control module to the tree. Returns a reference to the new control module on success.
_AddListenEffect	Adds a new listen effect module to the tree. Returns a reference to the new effect module on success.
_AddListenInput	Adds a new listen input module to the tree. Returns a reference to the new input module on success.
_AddListenModifier	Adds a new listen modifier module to the tree. Returns a reference to the new modifier module on success.
add_message_importing_tree	Register a listen module tree to buffer messages processed by this listen module tree.
add_message_to_buffer	Adds a message to the message buffer, and registers the appropriate signals to the tree.
disable	Disable this listen module tree, disallowing it's modules to receive messages.
enable	Enable this listen module tree, allowing it's modules to receive messages.
flush_message_buffer	Outputs all messages stored in the message buffer to the listener parent.
migrate_listen_tree	Migrates this listen module tree to a new speaker parent and origin.
process	Process the heard message, applying the effects of each listen modifier module.
remove_message_importing_tree	Unregister a listen module tree from buffering messages processed by this listen module tree.
request_enable	Add an enable request to this listen module tree.
unrequest_enable	Remove an enable request from this listen module tree.
update_listener_origin	Update this listen module tree's listener origin. This will cause parent to hear messages from the location of the new listener origin.

Var Details

var
auxiliary_trees
– /list/datum/listen_module_tree/auxiliary

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

var
enable_requests
–

The number of concurrent requests for this listen module tree to be enabled.

var
enabled
–

If disabled, this listen module tree will not receive any messages.

var
known_language_ids_with_subcount
– /list

An associative list of language datum subscription counts, indexed by the language ID.

var
known_languages_by_id
– /list/datum/language

An associative list of language datums, indexed by the language ID.

var
listen_control_ids_with_subcount
– /list

An associative list of listen control module subscription counts, indexed by the module ID.

var
listen_controls_by_id
– /list/datum/listen_module/control

An associative list of listen control modules, indexed by the module ID.

var
listen_effect_ids_with_subcount
– /list

An associative list of listen effect module subscription counts, indexed by the module ID.

var
listen_effects_by_id
– /list/datum/listen_module/effect

An associative list of listen effect modules, indexed by the module ID.

var
listen_input_ids_with_subcount
– /list

An associative list of listen input module subscription counts, indexed by the module ID.

var
listen_inputs_by_channel
– /list/list/datum/listen_module/input

An associative list of listen input modules, indexed by the module channel.

var
listen_inputs_by_id
– /list/datum/listen_module/input

An associative list of listen input modules, indexed by the module ID.

var
listen_modifier_ids_with_subcount
– /list

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

var
listen_modifiers_by_id
– /list/datum/listen_module/modifier

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

var
listener_origin
– /atom

The atom that should act as the origin point for listening to messages.

var
listener_parent
– /atom

The atom that should receive messages sent to this listen module tree.

var
message_buffer
– /list/datum/say_message

A temporary buffer of all received messages that are to be outputted to the parent when the buffer is flushed.

var
message_exporting_trees
– /list/datum/listen_module_tree

A list of all listen module trees that this listen module tree buffers processed messages from.

var
message_importing_trees
– /list/datum/listen_module_tree

A list of all listen module trees that buffer messages processed by this listen module tree.

var
persistent_listen_modifiers_by_id
– /list/datum/speech_module/modifier

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

var
secondary_parents
– /list/atom

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

var
signal_recipients
– /list/datum

An associative list of all signal recipients that may cause the message buffer to flush.

var
understands_all_languages
–

Whether this listen module tree is capable of understanding all languages.

Proc Details

proc
AddKnownLanguage
(language_id, count)

Adds a known language to this listen tree. Known languages allow messages to be understood. Returns TRUE on success, FALSE on failure.

proc
AddLanguageAllSubcount
(count)

Adds a count from the LANGUAGE_ALL subcount, and enables understands_all_languages.

proc
GetControlByID
(control_id)

Returns the listen control module that matches the specified ID.

proc
GetEffectByID
(effect_id)

Returns the listen effect module that matches the specified ID.

proc
GetInputByID
(input_id, subchannel)

Returns the listen input module that matches the specified ID.

proc
GetInputsByChannel
(channel_id)

Returns a list of listen input modules that receive from the specified channel.

proc
GetModifierByID
(modifier_id)

Returns the listen modifier module that matches the specified ID.

proc
RemoveKnownLanguage
(language_id, count)

Removes a known language from this listen tree. Known languages allow messages to be understood. Returns TRUE on success, FALSE on failure.

proc
RemoveLanguageAllSubcount
(count)

Removes a count from the LANGUAGE_ALL subcount, and disables understands_all_languages if no counts remain.

proc
RemoveListenControl
(control_id, count)

Removes a listen control module from the tree. Returns TRUE on success, FALSE on failure.

proc
RemoveListenEffect
(effect_id, count)

Removes a listen effect module from the tree. Returns TRUE on success, FALSE on failure.

proc
RemoveListenInput
(input_id, subchannel, count)

Removes a listen input module from the tree. Returns TRUE on success, FALSE on failure.

proc
RemoveListenModifier
(modifier_id, count)

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

proc
_AddListenControl
(control_id, /list/arguments, count)

Adds a new listen control module to the tree. Returns a reference to the new control module on success.

proc
_AddListenEffect
(effect_id, /list/arguments, count)

Adds a new listen effect module to the tree. Returns a reference to the new effect module on success.

proc
_AddListenInput
(input_id, /list/arguments, count)

Adds a new listen input module to the tree. Returns a reference to the new input module on success.

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

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

proc
add_message_importing_tree
(/datum/listen_module_tree/tree)

proc
add_message_to_buffer
(/datum/say_message/message)

Adds a message to the message buffer, and registers the appropriate signals to the tree.

proc
disable
()

Disable this listen module tree, disallowing it's modules to receive messages.

proc
enable
()

Enable this listen module tree, allowing it's modules to receive messages.

proc
flush_message_buffer
()

Outputs all messages stored in the message buffer to the listener parent.

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

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

proc
process
(/datum/say_message/message)

Process the heard message, applying the effects of each listen modifier module.

proc
remove_message_importing_tree
(/datum/listen_module_tree/tree)

Unregister a listen module tree from buffering messages processed by this listen module tree.

proc
request_enable
()

Add an enable request to this listen module tree.

proc
unrequest_enable
()

Remove an enable request from this listen module tree.

proc
update_listener_origin
(/atom/new_origin)

Update this listen module tree's listener origin. This will cause parent to hear messages from the location of the new listener origin.

/datum/listen_module_tree

Vars

Procs

Var Details

var auxiliary_trees – /list/datum/listen_module_tree/auxiliary

var enable_requests –

var enabled –

var known_language_ids_with_subcount – /list

var known_languages_by_id – /list/datum/language

var listen_control_ids_with_subcount – /list

var listen_controls_by_id – /list/datum/listen_module/control

var listen_effect_ids_with_subcount – /list

var listen_effects_by_id – /list/datum/listen_module/effect

var listen_input_ids_with_subcount – /list

var listen_inputs_by_channel – /list/list/datum/listen_module/input

var listen_inputs_by_id – /list/datum/listen_module/input

var listen_modifier_ids_with_subcount – /list

var listen_modifiers_by_id – /list/datum/listen_module/modifier

var listener_origin – /atom

var listener_parent – /atom

var message_buffer – /list/datum/say_message

var message_exporting_trees – /list/datum/listen_module_tree

var message_importing_trees – /list/datum/listen_module_tree

var persistent_listen_modifiers_by_id – /list/datum/speech_module/modifier

var secondary_parents – /list/atom

var signal_recipients – /list/datum

var understands_all_languages –

Proc Details

proc AddKnownLanguage(language_id, count)

proc AddLanguageAllSubcount(count)

proc GetControlByID(control_id)

proc GetEffectByID(effect_id)

proc GetInputByID(input_id, subchannel)

proc GetInputsByChannel(channel_id)

proc GetModifierByID(modifier_id)

proc RemoveKnownLanguage(language_id, count)

proc RemoveLanguageAllSubcount(count)

proc RemoveListenControl(control_id, count)

proc RemoveListenEffect(effect_id, count)

proc RemoveListenInput(input_id, subchannel, count)

proc RemoveListenModifier(modifier_id, count)

proc _AddListenControl(control_id, /list/arguments, count)

proc _AddListenEffect(effect_id, /list/arguments, count)

proc _AddListenInput(input_id, /list/arguments, count)

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

proc add_message_importing_tree(/datum/listen_module_tree/tree)

proc add_message_to_buffer(/datum/say_message/message)

proc disable()

proc enable()

proc flush_message_buffer()

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

proc process(/datum/say_message/message)

proc remove_message_importing_tree(/datum/listen_module_tree/tree)

proc request_enable()

proc unrequest_enable()

proc update_listener_origin(/atom/new_origin)