/datum/say_channel

Say channel datums govern the dissemination of messages to registered listen input module datums. In its simplest form, this involves a say message datum being passed from an output module to a channel, and the channel then performing shared input formatting before passing the say message to registered listen modules. Say channels also determine whether a message should be affected by output and input modifiers, and whether the sender should display a speech bubble and play a speech sound.

Vars
affected_by_modifiers	Whether messages sent through this channel should be affected by say or listen modifiers.
channel_id	This channel datum's channel ID.
disabled_message	The message to display to a speaker if they attempt to send a message over this channel while it is disabled.
enabled	If disabled, this channel will not receive nor send any messages.
listeners	An associative list of listeners registered to this channel, indexed by input module type.
module_tree_signal_registrations	An associative list of module trees, with the associated number of times a signal has been registered to them.
suppress_hear_sound	Whether recipients of messages sent through this channel should hear a sound on receiving a message.
suppress_say_sound	Whether the speaker of a message sent through this channel should make a sound on sending a message.
suppress_speech_bubble	Whether the speaker of a message sent through this channel should display a speech bubble on sending a message.
track_outermost_listener	Whether this local channel should request registered input modules to track their outermost listeners.
Procs
PassToChannel	The primary entry point for say message datums; they will be passed to this channel through this proc.
PassToListeners	Pass a message to all listen modules in a specified list, indexed in sublists by type.
PassToOverriddenAtomListeners	A secondary entry point for say message datums; they will not be passed over this channel conventionally, but rather disseminated to a stored list of atom listeners.
RegisterInput	Register a listener for hearing messages on a channel.
RegisterOutput	Set up an output module for sending messages over this channel.
UnregisterInput	Unregister a listener so it no longer receieves messages from this channel.
UnregisterOutput	Remove any setup applied to an output module that was sending messages over this channel.
log_message	If a message was spoken by a client, logs the message.

Var Details

var
affected_by_modifiers
–

Whether messages sent through this channel should be affected by say or listen modifiers.

var
channel_id
–

This channel datum's channel ID.

var
disabled_message
–

The message to display to a speaker if they attempt to send a message over this channel while it is disabled.

var
enabled
–

If disabled, this channel will not receive nor send any messages.

var
listeners
– /list/list/datum/listen_module/input

An associative list of listeners registered to this channel, indexed by input module type.

var
module_tree_signal_registrations
– /list

An associative list of module trees, with the associated number of times a signal has been registered to them.

var
suppress_hear_sound
–

Whether recipients of messages sent through this channel should hear a sound on receiving a message.

var
suppress_say_sound
–

Whether the speaker of a message sent through this channel should make a sound on sending a message.

var
suppress_speech_bubble
–

Whether the speaker of a message sent through this channel should display a speech bubble on sending a message.

var
track_outermost_listener
–

Whether this local channel should request registered input modules to track their outermost listeners.

Proc Details

proc
PassToChannel
(/datum/say_message/message)

The primary entry point for say message datums; they will be passed to this channel through this proc.

proc
PassToListeners
(/datum/say_message/message, /list/list/datum/listen_module/input/listen_modules_by_type)

Pass a message to all listen modules in a specified list, indexed in sublists by type.

proc
PassToOverriddenAtomListeners
(/datum/say_message/message)

A secondary entry point for say message datums; they will not be passed over this channel conventionally, but rather disseminated to a stored list of atom listeners.

proc
RegisterInput
(/datum/listen_module/input/registree)

proc
RegisterOutput
(/datum/speech_module/output/registree)

Set up an output module for sending messages over this channel.

proc
UnregisterInput
(/datum/listen_module/input/registered)

Unregister a listener so it no longer receieves messages from this channel.

proc
UnregisterOutput
(/datum/speech_module/output/registered)

Remove any setup applied to an output module that was sending messages over this channel.

proc
log_message
(/datum/say_message/message)

If a message was spoken by a client, logs the message.

/datum/say_channel

Vars

Procs

Var Details

var affected_by_modifiers –

var channel_id –

var disabled_message –

var enabled –

var listeners – /list/list/datum/listen_module/input

var module_tree_signal_registrations – /list

var suppress_hear_sound –

var suppress_say_sound –

var suppress_speech_bubble –

var track_outermost_listener –