/datum/say_message

The base message type; it contains the content of a message and all of the relevant metadata. Any text that has been passed to say() is in turn passed into a new say message datum.

Vars
atom_listeners_override	If set, this say message datum will be sent to these atoms as opposed to being broadcast over a say channel.
atom_listeners_to_be_excluded	If set, and `atom_listeners_override` is not set, this say message datum will not be sent to the atoms in this list when being broadcast over a say channel. Note that this is an associative list.
can_relay	If FALSE, this message will not be permitted to be retransmitted, regardless of the flags present in `relay_flags`.
card_ident	The worn identity of the speaker, if they have one.
content	The sanitised and processed content of this message.
face_ident	The facial identity of the speaker.
flags	Message flags. See `_std/defines/speech_defines/sayflags.dm`.
format_content_prefix	The formatting that should immediately follow `say_verb` and precede `format_content_style_prefix`.
format_content_style_prefix	The formatting that should immediately follow `format_content_prefix` and precede `content`. Will be grouped with `content` in maptext.
format_content_style_suffix	The formatting that should immediately follow `content` and precede `format_content_suffix`. Will be grouped with `content` in maptext.
format_content_suffix	The formatting that should immediately follow `format_content_style_suffix`.
format_speaker_prefix	The formatting that should immediately precede `speaker_to_display`.
format_verb_prefix	The formatting that should immediately follow `speaker_to_display` and precede `say_verb`.
hear_sound	The sound that should be played to listeners when this message is heard.
heard_range	The range of a heard message.
id	The non-unique ID of this message. A listener may only hear one message of a specific ID at any time.
language	The language that this message was sent in.
last_character	The last character of this message. Used to determine messages intonation, i.e: "?" will result in a message being treated as a question.
loudness	How loud a message is determines how large it is displayed in the text window.
maptext_animation_colours	A list of colours for the maptext to oscillate through. Use the "start_colour" value to determine the colour to animate from to `maptext_css_values["color"]`.
maptext_css_values	The CSS values for the maptext, stored as an associative list, i.e: "font-weight" = "bold".
maptext_prefix	A prefix that should only be displayed on the maptext.
maptext_suffix	A suffix that should only be displayed on the maptext.
maptext_variables	The variables for the maptext object, stored as an associative list, i.e: "alpha" = "140".
message_origin	The atom that should appear to have sent this message.
message_size_override	If set, overrides the `loudness` variable, and sets the font size of the message to the set value.
original_content	The original contents of this message, uneditied, unsanitised.
original_speaker	The atom that originally sent this message.
output_module_channel	The channel that this radio message should attempt to be sent on. If `null`, will be sent to all available outputs.
output_module_override	If set, the output module that this message should attempt to be passed to.
prefix	The radio prefix that this message was sent with.
real_ident	The real name of the speaker.
received_module	The input module that received this message last.
relay_flags	A bitflag of the various way that this message has been retransmitted. Used to prevent feedback loops.
say_sound	The sound that should play when this message is spoken.
say_verb	The verb to display when this message is received, i.e: "Jeff [say_verb], [message]"
signal_recipient	The datum that should act as a signal recipient for every copy of this message.
speaker	The atom that sent this message.
speaker_location_text	The text indicating where this message was spoken from, if it was spoken from inside of an object.
speaker_to_display	The name of the speaker that should be used when displaying the message to a listener. If null, defaults to the `speaker` atom.
voice_ident	The voice identity of the speaker.
whisper_verb	The verb to display when this message is received, if it is whispered.
Procs
Copy	Create a copy of this say message datum.
format_for_output	Returns a formatted message for use with `boutput()`, using either the last listen input module or falling back to the default format of `"[speaker] [say_verb], [content]"`.
get_speaker_name	Returns the heard name of the speaker, taking into account masks, voice changers, and IDs.
make_safe_for_chat	Removes forbidden characters, newlines, tabs, and HTML tags from a message, and checks for URLs.
process_say_sound	Determines the say sound that this message should use, and plays it.
process_speech_bubble	Determines the speech bubble that this message should use, and displays it on the speaker.
run_mob_and_client_checks	Checks whether the mob or client is muted, and applies preference data to the message's content.

Var Details

var
atom_listeners_override
– /list/atom

If set, this say message datum will be sent to these atoms as opposed to being broadcast over a say channel.

var
atom_listeners_to_be_excluded
– /list/atom

If set, and atom_listeners_override is not set, this say message datum will not be sent to the atoms in this list when being broadcast over a say channel. Note that this is an associative list.

var
can_relay
–

If FALSE, this message will not be permitted to be retransmitted, regardless of the flags present in relay_flags.

var
card_ident
–

The worn identity of the speaker, if they have one.

var
content
–

The sanitised and processed content of this message.

var
face_ident
–

The facial identity of the speaker.

var
flags
–

Message flags. See _std/defines/speech_defines/sayflags.dm.

var
format_content_prefix
–

The formatting that should immediately follow say_verb and precede format_content_style_prefix.

var
format_content_style_prefix
–

The formatting that should immediately follow format_content_prefix and precede content. Will be grouped with content in maptext.

var
format_content_style_suffix
–

The formatting that should immediately follow content and precede format_content_suffix. Will be grouped with content in maptext.

var
format_content_suffix
–

The formatting that should immediately follow format_content_style_suffix.

var
format_speaker_prefix
–

The formatting that should immediately precede speaker_to_display.

var
format_verb_prefix
–

The formatting that should immediately follow speaker_to_display and precede say_verb.

var
hear_sound
–

The sound that should be played to listeners when this message is heard.

var
heard_range
–

The range of a heard message.

var
id
–

The non-unique ID of this message. A listener may only hear one message of a specific ID at any time.

var
language
– /datum/language

The language that this message was sent in.

var
last_character
–

The last character of this message. Used to determine messages intonation, i.e: "?" will result in a message being treated as a question.

var
loudness
–

How loud a message is determines how large it is displayed in the text window.

var
maptext_animation_colours
– /list

A list of colours for the maptext to oscillate through. Use the "start_colour" value to determine the colour to animate from to maptext_css_values["color"].

var
maptext_css_values
– /list

The CSS values for the maptext, stored as an associative list, i.e: "font-weight" = "bold".

var
maptext_prefix
–

A prefix that should only be displayed on the maptext.

var
maptext_suffix
–

A suffix that should only be displayed on the maptext.

var
maptext_variables
– /list

The variables for the maptext object, stored as an associative list, i.e: "alpha" = "140".

var
message_origin
– /atom

The atom that should appear to have sent this message.

var
message_size_override
–

If set, overrides the loudness variable, and sets the font size of the message to the set value.

var
original_content
–

The original contents of this message, uneditied, unsanitised.

var
original_speaker
– /atom

The atom that originally sent this message.

var
output_module_channel
–

The channel that this radio message should attempt to be sent on. If null, will be sent to all available outputs.

var
output_module_override
–

If set, the output module that this message should attempt to be passed to.

var
prefix
–

The radio prefix that this message was sent with.

var
real_ident
–

The real name of the speaker.

var
received_module
– /datum/listen_module/input

The input module that received this message last.

var
relay_flags
–

A bitflag of the various way that this message has been retransmitted. Used to prevent feedback loops.

var
say_sound
–

The sound that should play when this message is spoken.

var
say_verb
–

The verb to display when this message is received, i.e: "Jeff [say_verb], [message]"

var
signal_recipient
– /datum

The datum that should act as a signal recipient for every copy of this message.

var
speaker
– /atom

The atom that sent this message.

var
speaker_location_text
–

The text indicating where this message was spoken from, if it was spoken from inside of an object.

var
speaker_to_display
–

The name of the speaker that should be used when displaying the message to a listener. If null, defaults to the speaker atom.

var
voice_ident
–

The voice identity of the speaker.

var
whisper_verb
–

The verb to display when this message is received, if it is whispered.

Proc Details

proc
Copy
()

Create a copy of this say message datum.

proc
format_for_output
(/atom/listener)

Returns a formatted message for use with boutput(), using either the last listen input module or falling back to the default format of "[speaker] [say_verb], [content]".

proc
get_speaker_name
(heard_name_only)

Returns the heard name of the speaker, taking into account masks, voice changers, and IDs.

proc
make_safe_for_chat
(message)

Removes forbidden characters, newlines, tabs, and HTML tags from a message, and checks for URLs.

proc
process_say_sound
()

Determines the say sound that this message should use, and plays it.

proc
process_speech_bubble
()

Determines the speech bubble that this message should use, and displays it on the speaker.

proc
run_mob_and_client_checks
()

Checks whether the mob or client is muted, and applies preference data to the message's content.

/datum/say_message

Vars

Procs

Var Details

var atom_listeners_override – /list/atom

var atom_listeners_to_be_excluded – /list/atom

var can_relay –

var card_ident –

var content –

var face_ident –

var flags –

var format_content_prefix –

var format_content_style_prefix –

var format_content_style_suffix –

var format_content_suffix –

var format_speaker_prefix –

var format_verb_prefix –

var hear_sound –

var heard_range –

var id –

var language – /datum/language

var last_character –

var loudness –

var maptext_animation_colours – /list

var maptext_css_values – /list

var maptext_prefix –

var maptext_suffix –

var maptext_variables – /list

var message_origin – /atom

var message_size_override –

var original_content –

var original_speaker – /atom

var output_module_channel –

var output_module_override –

var prefix –

var real_ident –

var received_module – /datum/listen_module/input

var relay_flags –

var say_sound –

var say_verb –

var signal_recipient – /datum

var speaker – /atom

var speaker_location_text –

var speaker_to_display –

var voice_ident –

var whisper_verb –