datum

Vars
admin_music_volume	Admin music volume, from 0 to 1.
adminhelptimerid	Client var used for returning the ahelp verb
completed_asset_jobs	List of all completed blocking send jobs awaiting acknowledgement by send_asset
connection_time	world.time they connected
current_ticket	Client var used for tracking the ticket the (usually) not-admin client is dealing with
holding_click	Whether or not the player is holding their mouse click
ignore_next_click	Means that there can only be one click per mousedown.
key_combos_held	A buffer for combinations such of modifiers + keys (ex: CtrlD, AltE, ShiftT). Format: `"key"` -> `"combo"` (ex: `"D"` -> `"CtrlD"`)
keys_held	A buffer of currently held keys.
last_asset_job	Last asset send job id.
mouse_trace_history	The history of all atoms that were hovered over while the mouse was depressed
movement_keys	custom movement keys for this client
movement_locked	Are we locking our movement input?
next_move_dir_add	On next move, add this dir to the move that would otherwise be done
next_move_dir_sub	On next move, subtract this dir from the move that would otherwise be done
obj_window	Our object window datum. It stores info about and handles behavior for the object tab
panel_tabs	list of all tabs
recent_examines	A lazy list of atoms we've examined in the last EXAMINE_MORE_TIME (default 1.5) seconds, so that we will call [/atom/proc/examine_more] instead of [/atom/proc/examine] on them when examining
screen_maps	Assoc list with all the active maps - when a screen obj is added to a map, it's put in here as well.
screen_texts	lazylist of screen_texts for this client, first in this list is the one playing
stat_panel	Stat panel window declaration
stat_tab	our current tab
tgui_cache_reloaded	global
tgui_say	Assigned say modal of the client
tgui_windows	global
topiclimiter	Used for limiting the rate of topic sends by the client to avoid abuse
typing_indicators	Does this client have typing indicators enabled?
urgent_ahelp_cooldown	The last urgent ahelp that this player sent
Procs
admin_follow	Attempts to make the client orbit the given object, for administrative purposes. If they are not an observer, will try to aghost them.
asset_cache_confirm_arrival	Process asset cache client topic calls for "asset_cache_confirm_arrival=[INT]"
asset_cache_preload_data	Process asset cache client topic calls for "asset_cache_preload_data=[HTML+JSON_STRING]
asset_cache_update_json	Updates the client side stored json file used to keep track of what assets the client has between restarts/reconnects.
browse_queue_flush	Blocks until all currently sending browse and browse_rsc assets have been sent. Due to byond limitations, this proc will sleep for 1 client round trip even if the client has no pending asset sends. This proc will return an untrue value if it had to return before confirming the send, such as timeout or the client going away.
clear_all_maps	Clears all the maps of registered screen objects.
clear_map	Clears the map of registered screen objects.
close_popup	Closes a popup.
create_popup	Creates a popup window with a basic map element in it, without any further initialization.
erase_all_macros	Erases macros set by the keybinding system
fix_tgui_panel	tgui panel / chat troubleshooting verb
get_total_drone_playtime	playtime for drone and drone evolution castes
get_total_t3_playtime	playtime for t3 castes and queen
get_total_xeno_playtime	playtime for all castes
handle_popup_close	When the popup closes in any way (player or proc call) it calls this.
init_verbs	Compiles a full list of verbs to be sent to the browser Sends the 2D verbs vector of (verb category, verb name)
keyUp	Check if the key is short enough to even be a real key
nanoclose	Called when a Nano UI window is closed This is how Nano handles closed windows It must be a verb so that it can be called using winset
notify_login	Handles login-related logging and associated notifications
on_stat_panel_message	Handles incoming messages from the stat-panel TGUI.
open_particle_editor	opens the particle editor UI for the in_atom object for this client
register_map_obj	Registers screen obj with the client, which makes it visible on the assigned map, and becomes a part of the assigned map's lifecycle.
reset_held_keys	Manually clears any held keys, in case due to lag or other undefined behavior a key gets stuck.
set_macros	Request blocking update of keybinds to client, clearing old ones
setup_popup	Create the popup, and get it ready for generic use by giving it a background.
show_other_record	Management Access Edit Access Note category options
tgui_say_create_open_command	Creates a JSON encoded message to open TGUI say modals properly.
uiclose	verb
update_special_keybinds	Updates the keybinds for special keys
who	Can remove notes from anyone other than yourself, unless you're the host. So long as you have deletion access anyway.

Var Details

var
admin_music_volume
–

Admin music volume, from 0 to 1.

var
adminhelptimerid
–

Client var used for returning the ahelp verb

var
completed_asset_jobs
– /list

List of all completed blocking send jobs awaiting acknowledgement by send_asset

var
connection_time
–

world.time they connected

var
current_ticket
– /datum/admin_help

Client var used for tracking the ticket the (usually) not-admin client is dealing with

var
holding_click
–

Whether or not the player is holding their mouse click

var
ignore_next_click
–

Means that there can only be one click per mousedown.

var
key_combos_held
– /list

A buffer for combinations such of modifiers + keys (ex: CtrlD, AltE, ShiftT). Format: "key" -> "combo" (ex: "D" -> "CtrlD")

var
keys_held
– /list

A buffer of currently held keys.

var
last_asset_job
–

Last asset send job id.

var
mouse_trace_history
– /list

The history of all atoms that were hovered over while the mouse was depressed

var
movement_keys
– /list

custom movement keys for this client

var
movement_locked
–

Are we locking our movement input?

var
next_move_dir_add
–

On next move, add this dir to the move that would otherwise be done

var
next_move_dir_sub
–

On next move, subtract this dir from the move that would otherwise be done

var
obj_window
– /datum/object_window_info

Our object window datum. It stores info about and handles behavior for the object tab

var
panel_tabs
– /list

list of all tabs

var
recent_examines
– /list

A lazy list of atoms we've examined in the last EXAMINE_MORE_TIME (default 1.5) seconds, so that we will call [/atom/proc/examine_more] instead of [/atom/proc/examine] on them when examining

var
screen_maps
– /list

Assoc list with all the active maps - when a screen obj is added to a map, it's put in here as well.

Format: list( = list(/atom/movable/screen))

var
screen_texts
– /list/atom/movable/screen/text/screen_text

lazylist of screen_texts for this client, first in this list is the one playing

var
stat_panel
– /datum/tgui_window

Stat panel window declaration

var
stat_tab
–

our current tab

var
tgui_cache_reloaded
–

global

TRUE if cache was reloaded by tgui dev server at least once.

var
tgui_say
– /datum/tgui_say

Assigned say modal of the client

var
tgui_windows
– /list

global

Tracks open windows for a user.

var
topiclimiter
– /list

Used for limiting the rate of topic sends by the client to avoid abuse

var
typing_indicators
–

Does this client have typing indicators enabled?

var
urgent_ahelp_cooldown
–

The last urgent ahelp that this player sent

Proc Details

proc
admin_follow
(/atom/movable/target)

Attempts to make the client orbit the given object, for administrative purposes. If they are not an observer, will try to aghost them.

proc
asset_cache_confirm_arrival
(job_id)

Process asset cache client topic calls for "asset_cache_confirm_arrival=[INT]"

proc
asset_cache_preload_data
(data)

Process asset cache client topic calls for "asset_cache_preload_data=[HTML+JSON_STRING]

proc
asset_cache_update_json
()

Updates the client side stored json file used to keep track of what assets the client has between restarts/reconnects.

proc
browse_queue_flush
(timeout)

Blocks until all currently sending browse and browse_rsc assets have been sent. Due to byond limitations, this proc will sleep for 1 client round trip even if the client has no pending asset sends. This proc will return an untrue value if it had to return before confirming the send, such as timeout or the client going away.

proc
clear_all_maps
()

Clears all the maps of registered screen objects.

proc
clear_map
(map_name)

Clears the map of registered screen objects.

Not really needed most of the time, as the client's screen list gets reset on relog. any of the buttons are going to get caught by garbage collection anyway. they're effectively qdel'd.

proc
close_popup
(popup)

Closes a popup.

proc
create_popup
(name, ratiox, ratioy)

Creates a popup window with a basic map element in it, without any further initialization.

Ratio is how many pixels by how many pixels (keep it simple).

Returns a map name.

proc
erase_all_macros
()

Erases macros set by the keybinding system

verb
fix_tgui_panel
()

tgui panel / chat troubleshooting verb

proc
get_total_drone_playtime
()

playtime for drone and drone evolution castes

proc
get_total_t3_playtime
()

playtime for t3 castes and queen

proc
get_total_xeno_playtime
(skip_cache)

playtime for all castes

verb
handle_popup_close
(window_id)

When the popup closes in any way (player or proc call) it calls this.

proc
init_verbs
()

Compiles a full list of verbs to be sent to the browser Sends the 2D verbs vector of (verb category, verb name)

verb
keyUp
(_key)

Check if the key is short enough to even be a real key

verb
nanoclose
(uiref)

Called when a Nano UI window is closed This is how Nano handles closed windows It must be a verb so that it can be called using winset

@return nothing

proc
notify_login
()

Handles login-related logging and associated notifications

proc
on_stat_panel_message
(type, payload)

Handles incoming messages from the stat-panel TGUI.

proc
open_particle_editor
(/atom/movable/in_atom)

opens the particle editor UI for the in_atom object for this client

proc
register_map_obj
(/atom/movable/screen/screen_obj)

Registers screen obj with the client, which makes it visible on the assigned map, and becomes a part of the assigned map's lifecycle.

verb
reset_held_keys
()

Manually clears any held keys, in case due to lag or other undefined behavior a key gets stuck.

Hardcoded to the ESC key.

proc
set_macros
()

Request blocking update of keybinds to client, clearing old ones

proc
setup_popup
(popup_name, width, height, tilesize, bg_icon)

Create the popup, and get it ready for generic use by giving it a background.

Width and height are multiplied by 64 by default.

proc
show_other_record
(note_category, category_text, target, can_edit, can_del)

Management Access Edit Access Note category options

proc
tgui_say_create_open_command
(channel)

Creates a JSON encoded message to open TGUI say modals properly.

Arguments: channel - The channel to open the modal in. Returns: string - A JSON encoded message to open the modal.

verb
uiclose
(window_id)

verb

Called by UIs when they are closed. Must be a verb so winset() can call it.

required uiref ref The UI that was closed.

proc
update_special_keybinds
(/datum/preferences/direct_prefs)

Updates the keybinds for special keys

Handles adding macros for the keys that need it And adding movement keys to the clients movement_keys list At the time of writing this, communication(OOC, Say, IC) require macros Arguments:

direct_prefs - the preference we're going to get keybinds from

verb
who
()

Can remove notes from anyone other than yourself, unless you're the host. So long as you have deletion access anyway.

/client inherits /datum

Vars

Procs

Var Details

var admin_music_volume –

var adminhelptimerid –

var completed_asset_jobs – /list

var connection_time –

var current_ticket – /datum/admin_help

var holding_click –

var ignore_next_click –

var key_combos_held – /list

var keys_held – /list

var last_asset_job –

var mouse_trace_history – /list

var movement_keys – /list

var movement_locked –

var next_move_dir_add –

var next_move_dir_sub –

var obj_window – /datum/object_window_info

var panel_tabs – /list

var recent_examines – /list

var screen_maps – /list

var screen_texts – /list/atom/movable/screen/text/screen_text

var stat_panel – /datum/tgui_window

var stat_tab –

var tgui_cache_reloaded –

var tgui_say – /datum/tgui_say

var tgui_windows – /list

var topiclimiter – /list

var typing_indicators –

var urgent_ahelp_cooldown –

Proc Details

proc admin_follow(/atom/movable/target)

proc asset_cache_confirm_arrival(job_id)

proc asset_cache_preload_data(data)

proc asset_cache_update_json()

proc browse_queue_flush(timeout)

proc clear_all_maps()

proc clear_map(map_name)

proc close_popup(popup)

proc create_popup(name, ratiox, ratioy)

proc erase_all_macros()

verb fix_tgui_panel()

proc get_total_drone_playtime()

proc get_total_t3_playtime()

proc get_total_xeno_playtime(skip_cache)

verb handle_popup_close(window_id)

proc init_verbs()

verb keyUp(_key)

verb nanoclose(uiref)

proc notify_login()

proc on_stat_panel_message(type, payload)

proc open_particle_editor(/atom/movable/in_atom)

proc register_map_obj(/atom/movable/screen/screen_obj)

verb reset_held_keys()

proc set_macros()

proc setup_popup(popup_name, width, height, tilesize, bg_icon)

proc show_other_record(note_category, category_text, target, can_edit, can_del)

proc tgui_say_create_open_command(channel)

verb uiclose(window_id)

proc update_special_keybinds(/datum/preferences/direct_prefs)

verb who()