radio

Vars
b_stat	The build status of this radio, determining whether it can be attached to other objects, and other objects attached to it.
bricked	If TRUE, this radio will no longer be capable of sending nor receiving messages.
bricked_msg	The message that should be displayed when an attempt is made to use a bricked radio.
broadcasting	This is solely used to reconcile renaming the radio variables with `.dmm` files. Remove in a followup PR.
chat_class	The CSS class that should be used for messages sent over the primary channel of this radio. Overridden by `device_color`.
device_color	Determines the colour of messages sent by the radio and certain aspects of this device's sprite.
forced_maptext	Whether this radio will always display maptext.
frequency	The frequency of the primary channel of this radio.
hardened	Whether this radio is capable of sending messages during solar flares.
has_microphone	Whether this radio should display a microphone component in its UI.
icon_override	If set, this is radio icon that this radio should display on sent messages. See the `browserassets/images/radio_icons` folder.
icon_tooltip	If set, the tooltip that the radio icon of this radio should use. `null` will result in the radio name being used. "" will result in no tooltip.
initial_microphone_enabled	Whether this radio's microphone starts enabled.
initial_speaker_enabled	Whether this radio's speaker starts enabled.
last_transmission	The world time of this radio's last transmission.
locked_frequency	Whether the primary frequency may be changed from its default setting. If TRUE, permits the frequency to exist outside of the default range.
microphone_enabled	Whether this radio's microphone is enabled. If so, it will be capable of hearing spoken messages within a range around it.
microphone_listen_input	The listen input module that this radio's microphone should use.
protected_radio	If TRUE, messages sent over a protected channel cannot be picked up by the `radio_brain` bioeffect.
secure_classes	The CSS class that should be used for messages sent over each channel, indexed by channel prefix. Alternatively a single class may be defined for all channels to use that style. Overridden by `secure_colors`.
secure_colors	The colour that should be used for messages sent over each channel, indexed by channel prefix. Alternatively a single colour may be defined for all channels to use that colour. Overrides `secure_classes`.
secure_connections	A list of radio packet componenets that this radio has attached to it, indexed by channel prefix.
secure_frequencies	A list of available secure radio channel frequencies, indexed by channel prefix.
speaker_enabled	Whether this radio's speaker is enabled. If not, received radio messages will not be spoken.
speaker_range	The range in which radio messages received by this radio should be spoken to listeners.
traitor_frequency	The radio frequency that, when this radio is tuned to it, will unlock the traitor uplink.
traitorradio	The integrated traitor radio uplink.
wires	This radio's wires, determining whether it can receive and transmit.
Procs
radio_icon	Returns the HTML radio icon and tooltip.
set_frequency	Sets the primary frequency of the radio to a specified frequency.
set_secure_frequencies	Initialises the `secure_connections` list from the frequencies listed in `secure_frequencies`.
set_secure_frequency	Sets a secure frequency, specified using its channel prefix, to a new frequency.
toggle_microphone	Toggles the radio microphone, determining whether it is capable of hearing spoken messages within a range around it.
toggle_speaker	Toggles the radio speaker, determining whether received radio messages should be spoken.

Var Details

var
b_stat
–

The build status of this radio, determining whether it can be attached to other objects, and other objects attached to it.

var
bricked
–

If TRUE, this radio will no longer be capable of sending nor receiving messages.

var
bricked_msg
–

The message that should be displayed when an attempt is made to use a bricked radio.

var
broadcasting
–

This is solely used to reconcile renaming the radio variables with .dmm files. Remove in a followup PR.

var
chat_class
–

The CSS class that should be used for messages sent over the primary channel of this radio. Overridden by device_color.

var
device_color
–

Determines the colour of messages sent by the radio and certain aspects of this device's sprite.

var
forced_maptext
–

Whether this radio will always display maptext.

var
frequency
–

The frequency of the primary channel of this radio.

var
hardened
–

Whether this radio is capable of sending messages during solar flares.

var
has_microphone
–

Whether this radio should display a microphone component in its UI.

var
icon_override
–

If set, this is radio icon that this radio should display on sent messages. See the browserassets/images/radio_icons folder.

If set, the tooltip that the radio icon of this radio should use. null will result in the radio name being used. "" will result in no tooltip.

var
initial_microphone_enabled
–

Whether this radio's microphone starts enabled.

var
initial_speaker_enabled
–

Whether this radio's speaker starts enabled.

var
last_transmission
–

The world time of this radio's last transmission.

var
locked_frequency
–

Whether the primary frequency may be changed from its default setting. If TRUE, permits the frequency to exist outside of the default range.

var
microphone_enabled
–

Whether this radio's microphone is enabled. If so, it will be capable of hearing spoken messages within a range around it.

var
microphone_listen_input
–

The listen input module that this radio's microphone should use.

var
protected_radio
–

If TRUE, messages sent over a protected channel cannot be picked up by the radio_brain bioeffect.

var
secure_classes
– /list

The CSS class that should be used for messages sent over each channel, indexed by channel prefix. Alternatively a single class may be defined for all channels to use that style. Overridden by secure_colors.

var
secure_colors
– /list

The colour that should be used for messages sent over each channel, indexed by channel prefix. Alternatively a single colour may be defined for all channels to use that colour. Overrides secure_classes.

var
secure_connections
– /list/datum/component/packet_connected/radio

A list of radio packet componenets that this radio has attached to it, indexed by channel prefix.

var
secure_frequencies
– /list

A list of available secure radio channel frequencies, indexed by channel prefix.

var
speaker_enabled
–

Whether this radio's speaker is enabled. If not, received radio messages will not be spoken.

var
speaker_range
–

The range in which radio messages received by this radio should be spoken to listeners.

var
traitor_frequency
–

The radio frequency that, when this radio is tuned to it, will unlock the traitor uplink.

var
traitorradio
– /obj/item/uplink/integrated/radio

The integrated traitor radio uplink.

var
wires
–

This radio's wires, determining whether it can receive and transmit.

Proc Details

proc
radio_icon
(/mob/user)

Returns the HTML radio icon and tooltip.

proc
set_frequency
(new_frequency)

Sets the primary frequency of the radio to a specified frequency.

proc
set_secure_frequencies
()

Initialises the secure_connections list from the frequencies listed in secure_frequencies.

proc
set_secure_frequency
(frequencyToken, newFrequency)

Sets a secure frequency, specified using its channel prefix, to a new frequency.

proc
toggle_microphone
(microphone_enabled)

Toggles the radio microphone, determining whether it is capable of hearing spoken messages within a range around it.

proc
toggle_speaker
(speaker_enabled)

Toggles the radio speaker, determining whether received radio messages should be spoken.

station bounced radio /obj/item/device/radio

Vars

Procs

Var Details

var b_stat –

var bricked –

var bricked_msg –

var broadcasting –

var chat_class –

var device_color –

var forced_maptext –

var frequency –

var hardened –

var has_microphone –

var icon_override –

var icon_tooltip –

var initial_microphone_enabled –

var initial_speaker_enabled –

var last_transmission –

var locked_frequency –

var microphone_enabled –

var microphone_listen_input –

var protected_radio –

var secure_classes – /list

var secure_colors – /list

var secure_connections – /list/datum/component/packet_connected/radio

var secure_frequencies – /list

var speaker_enabled –

var speaker_range –

var traitor_frequency –

var traitorradio – /obj/item/uplink/integrated/radio

var wires –