tgui_panel

tgui_panel datum Hosts tgchat and other nice features.

Vars
admins_warned	Each client notifies on protected playback, so this prevents spamming admins.
all_emotes	Static list of all available emotes
telemetry_analyzed_at	Time of telemetry analysis completion
telemetry_connections	List of previous client connections
telemetry_requested_at	Time of telemetry request
Procs
analyze_telemetry	private
emotes_create	Creates a new custom emote entry
emotes_remove	Removes an existing custom emote entry
emotes_rename	Renames an existing custom emote entry
emotes_send_list	Sends the current list of custom emotes to the UI
initialize	public
is_ready	public
on_initialize_timed_out	private
play_music	public
populate_all_emotes_list	Initialize list of all available emotes with their keys Called on New()
request_telemetry	private
send_roundrestart	public
stop_music	public

Var Details

var
admins_warned
– /static

Each client notifies on protected playback, so this prevents spamming admins.

var
all_emotes
– /static/list

Static list of all available emotes

var
telemetry_analyzed_at

Time of telemetry analysis completion

var
telemetry_connections
– /list

List of previous client connections

var
telemetry_requested_at

Time of telemetry request

Proc Details

proc
analyze_telemetry
(payload)

private

Analyzes a telemetry packet.

Is currently only useful for detecting ban evasion attempts.

proc
emotes_create
(emote_key, emote_name)

Creates a new custom emote entry

Arguments:

emote_key - The key of the emote to add
emote_name - The display name for the emote

Returns TRUE on success, FALSE on failure

proc
emotes_remove
(emote_key, old_emote_name)

Removes an existing custom emote entry

Arguments:

emote_key - The key of the emote to remove
old_emote_name - The current display name of the emote

Returns TRUE on success, FALSE on cancellation

proc
emotes_rename
(emote_key, old_emote_name)

Renames an existing custom emote entry

Arguments:

emote_key - The key of the emote to rename
old_emote_name - The current display name of the emote

Returns TRUE on success, FALSE on cancellation

proc
emotes_send_list
()

Sends the current list of custom emotes to the UI

proc
initialize
(force)

public

Initializes tgui panel.

proc
is_ready
()

public

TRUE if panel is initialized and ready to receive messages.

proc
on_initialize_timed_out
()

private

Called when initialization has timed out.

proc
play_music
(url, extra_data)

public

Sends music data to the browser.

Optional settings:

pitch: the playback rate
start: the start time of the sound
end: when the musics stops playing

required url string Must be an https URL. optional extra_data list Optional settings.

proc
populate_all_emotes_list
()

Initialize list of all available emotes with their keys Called on New()

proc
request_telemetry
()

private

Requests some telemetry from the client.

proc
send_roundrestart
()

public

Sends a round restart notification.

proc
stop_music
()

public

Stops playing music through the browser.

tgui_panel /datum/tgui_panel

Vars

Procs

Var Details

var admins_warned – /static

var all_emotes – /static/list

var telemetry_analyzed_at

var telemetry_connections – /list

var telemetry_requested_at

Proc Details

proc analyze_telemetry(payload)

proc emotes_create(emote_key, emote_name)

proc emotes_remove(emote_key, old_emote_name)

proc emotes_rename(emote_key, old_emote_name)

proc emotes_send_list()

proc initialize(force)

proc is_ready()

proc on_initialize_timed_out()

proc play_music(url, extra_data)

proc populate_all_emotes_list()

proc request_telemetry()

proc send_roundrestart()

proc stop_music()

tgui_panel
/datum/tgui_panel

var
admins_warned
– /static

var
all_emotes
– /static/list

var
telemetry_analyzed_at

var
telemetry_connections
– /list

var
telemetry_requested_at

proc
analyze_telemetry
(payload)

proc
emotes_create
(emote_key, emote_name)

proc
emotes_remove
(emote_key, old_emote_name)

proc
emotes_rename
(emote_key, old_emote_name)

proc
emotes_send_list
()

proc
initialize
(force)

proc
is_ready
()

proc
on_initialize_timed_out
()

proc
play_music
(url, extra_data)

proc
populate_all_emotes_list
()

proc
request_telemetry
()

proc
send_roundrestart
()

proc
stop_music
()