datum

Vars
AI_Interact	Used for admin AI interaction
account_age	Age of byond account in days
account_join_date	Date of byond account creation in ISO 8601 format
active_mousedown_item	Autoclick variable referencing the associated item.
admin_music_volume	Copyright (c) 2020 Aleksej Komarov SPDX-License-Identifier: MIT Admin music volume, from 0 to 1.
area	Current area of the controlled mob
avgping	Average ping of the client
ban_cache	Used to cache this client's bans to save on DB queries
char_render_holders	Should only be a key-value list of north/south/east/west = atom/movable/screen.
click_intercept	Needs to implement InterceptClickOn(user,params,atom) proc
click_intercept_time	Time when the click was intercepted
clicklimiter	Used for limiting the rate of clicks sends by the client to avoid abuse
client_keysend_amount	Amount of keydowns in the last keysend checking interval
connection_realtime	world.realtime they connected
connection_time	world.time they connected
connection_timeofday	world.timeofday they connected
credits	lazy list of all credit object bound to this client
crew_manifest_delay	rate limiting for the crew manifest
dont_animate_parallax	world.time of when we can state animate()ing parallax again
externalreplyamount	Internal counter for clients sending external (IRC/Discord) relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.
holder	Contains admin info. Null if client is not an admin.
inprefs	If the client is currently in player preferences
interviewee	If the client is currently under the restrictions of the interview system
ip_intel	Used for ip intel checking to identify evaders, disabled because of issues with traffic
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.
keysend_tripped	When set to true, user will be autokicked if they trip the keysends in a second limit again
last_asset_job	List of all completed blocking send jobs awaiting acknowledgement by send_asset
last_completed_asset_job	Last asset send job id.
last_message	Contains the last message sent by this client - used to protect against copy-paste spamming.
last_message_count	contins a number of how many times a message identical to last_message was sent.
last_parallax_shift	world.time of last parallax update
last_seen_afk	Used by SSserver_maint to detect if a client is newly AFK.
last_turn	last turn of the controlled mob, I think this is only used by mechs?
lastping	Last ping of the client
mouseLocation	Used in MouseDrag to preserve the last mouse-entered location.
mouseObject	Used in MouseDrag to preserve the last mouse-entered object.
mouseParams	Used in MouseDrag to preserve the original mouse click parameters
mouse_down_icon	used to make a special mouse cursor, this one for mouse up icon
mouse_override_icon	used to override the mouse cursor so it doesnt get reset
mouse_up_icon	used to make a special mouse cursor, this one for mouse up icon
move_delay	Move delay of controlled mob, related to input handling
movement_keys	custom movement keys for this client
next_keysend_reset	World tick time where client_keysend_amount will reset
next_keysend_trip_reset	World tick time where keysend_tripped will reset back to false
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
parallax_throttle	ds between parallax updates
player_age	Used to determine how old the account is - in days.
player_details	these persist between logins/logouts during the same round.
player_join_date	Date that this account was first seen in the server
prefs	Player preferences datum for the client
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
related_accounts_cid	So admins know why it isn't working - Used to determine what other accounts previously logged in from this computer id
related_accounts_ip	So admins know why it isn't working - Used to determine what other accounts previously logged in from this ip
say_slowmode	Tracks say() usage for ic/dchat while slowmode is enabled
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
script	!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!HEY LISTEN!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
seen_messages	Messages currently seen by this client
selected_target	Autoclick list of two elements, first being the clicked thing, second being the parameters.
show_verb_panel	hides the byond verb panel as we use our own custom version
spell_tabs	list of tabs containing spells and abilities
stat_panel	Stat panel window declaration
stat_tab	our current tab
tgui_cache_reloaded	global
tgui_panel	Copyright (c) 2020 Aleksej Komarov SPDX-License-Identifier: MIT
tgui_windows	global
tooltips	datum that controls the displaying and hiding of tooltips
topiclimiter	Used for limiting the rate of topic sends by the client to avoid abuse
total_count_reset	Next tick to reset the total message counter
total_message_count	How many messages sent in the last 10 seconds
view_size	datum wrapper for client view
Procs
Move	Move a client in a direction
Move_object	force move the control_object of your client mob
Process_Grab	Checks to see if you're being grabbed and if so attempts to break it
Process_Incorpmove	Allows mobs to ignore density and phase through objects
_Topic	dumb workaround because byond doesnt seem to recognize the PROC_REF(Topic()) typepath for /datum/proc/Topic() from the client Topic, so we cant queue it without this
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.
body_chest	Hidden verb to target the chest, bound to 5
body_groin	Hidden verb to target the groin, bound to 2
body_l_arm	Hidden verb to target the left arm, bound to 6
body_l_leg	Hidden verb to target the left leg, bound to 3
body_r_arm	Hidden verb to target the right arm, bound to 4
body_r_leg	Hidden verb to target the right leg, bound to 1
body_toggle_head	Hidden verb to set the target zone of a mob to the head
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.
check_has_body_select	Validate the client's mob has a valid zone selected
check_timer_sources	A debug verb to check the sources of currently running timers
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.
drop_item	If your mob is concious, drop the item in the active hand
edit_mentors	It's like permissions panel, but for mentors, also probably less secure, but honestly dude its mentors, not actual dangerous perms
fax_panel	If client have R_ADMIN flag, opens an admin fax panel.
fix_tgui_panel	tgui panel / chat troubleshooting verb
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 and sends it to the browser
initialize_menus	Initializes dropdown menus on client
keyUp	Check if the key is short enough to even be a real key
on_stat_panel_message	Handles incoming messages from the stat-panel TGUI.
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.
requests	Verb for opening the requests manager panel
reset_held_keys	Manually clears any held keys, in case due to lag or other undefined behavior a key gets stuck.
send_resources	Send resources to the client. Sends both game resources and browser assets.
setup_popup	Create the popup, and get it ready for generic use by giving it a background.
toggle_walk_run	Verb to toggle the walk or run status
uiclose	verb
update_special_keybinds	Updates the keybinds for special keys

Var Details

var
AI_Interact
–

Used for admin AI interaction

var
account_age
–

Age of byond account in days

var
account_join_date
–

Date of byond account creation in ISO 8601 format

var
active_mousedown_item
– /obj/item

Autoclick variable referencing the associated item.

var
admin_music_volume
–

var
area
–

Current area of the controlled mob

var
avgping
–

Average ping of the client

var
ban_cache
–

Used to cache this client's bans to save on DB queries

var
char_render_holders
– /list

Should only be a key-value list of north/south/east/west = atom/movable/screen.

var
click_intercept
– /datum

Needs to implement InterceptClickOn(user,params,atom) proc

var
click_intercept_time
–

Time when the click was intercepted

var
clicklimiter
– /list

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

var
client_keysend_amount
–

Amount of keydowns in the last keysend checking interval

var
connection_realtime
–

world.realtime they connected

var
connection_time
–

world.time they connected

var
connection_timeofday
–

world.timeofday they connected

var
credits
– /list

lazy list of all credit object bound to this client

var
crew_manifest_delay
–

rate limiting for the crew manifest

var
dont_animate_parallax
–

world.time of when we can state animate()ing parallax again

var
externalreplyamount
–

Internal counter for clients sending external (IRC/Discord) relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.

var
holder
– /datum/admins

Contains admin info. Null if client is not an admin.

var
inprefs
–

If the client is currently in player preferences

var
interviewee
–

If the client is currently under the restrictions of the interview system

var
ip_intel
–

Used for ip intel checking to identify evaders, disabled because of issues with traffic

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
keysend_tripped
–

When set to true, user will be autokicked if they trip the keysends in a second limit again

var
last_asset_job
–

List of all completed blocking send jobs awaiting acknowledgement by send_asset

var
last_completed_asset_job
–

Last asset send job id.

var
last_message
–

Contains the last message sent by this client - used to protect against copy-paste spamming.

var
last_message_count
–

contins a number of how many times a message identical to last_message was sent.

var
last_parallax_shift
–

world.time of last parallax update

var
last_seen_afk
–

Used by SSserver_maint to detect if a client is newly AFK.

var
last_turn
–

last turn of the controlled mob, I think this is only used by mechs?

var
lastping
–

Last ping of the client

var
mouseLocation
–

Used in MouseDrag to preserve the last mouse-entered location.

var
mouseObject
–

Used in MouseDrag to preserve the last mouse-entered object.

var
mouseParams
–

Used in MouseDrag to preserve the original mouse click parameters

var
mouse_down_icon
–

used to make a special mouse cursor, this one for mouse up icon

var
mouse_override_icon
–

used to override the mouse cursor so it doesnt get reset

var
mouse_up_icon
–

used to make a special mouse cursor, this one for mouse up icon

var
move_delay
–

Move delay of controlled mob, related to input handling

var
movement_keys
– /list

custom movement keys for this client

var
next_keysend_reset
–

World tick time where client_keysend_amount will reset

var
next_keysend_trip_reset
–

World tick time where keysend_tripped will reset back to false

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
parallax_throttle
–

ds between parallax updates

var
player_age
–

Used to determine how old the account is - in days.

var
player_details
– /datum/player_details

these persist between logins/logouts during the same round.

var
player_join_date
–

Date that this account was first seen in the server

var
prefs
– /datum/preferences

Player preferences datum for the client

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
related_accounts_cid
–

So admins know why it isn't working - Used to determine what other accounts previously logged in from this computer id

var
related_accounts_ip
–

So admins know why it isn't working - Used to determine what other accounts previously logged in from this ip

var
say_slowmode
–

Tracks say() usage for ic/dchat while slowmode is enabled

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
script
–

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!HEY LISTEN!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

var
seen_messages
– /list

Messages currently seen by this client

var
selected_target
– /list/list/atom

Autoclick list of two elements, first being the clicked thing, second being the parameters.

var
show_verb_panel
–

hides the byond verb panel as we use our own custom version

var
spell_tabs
– /list

list of tabs containing spells and abilities

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_panel
– /datum/tgui_panel

var
tgui_windows
– /list

global

Tracks open windows for a user.

var
tooltips
– /datum/tooltip

datum that controls the displaying and hiding of tooltips

var
topiclimiter
– /list

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

var
total_count_reset
–

Next tick to reset the total message counter

var
total_message_count
–

How many messages sent in the last 10 seconds

var
view_size
– /datum/viewData

datum wrapper for client view

Proc Details

proc
Move
(n, direct)

Move a client in a direction

Huge proc, has a lot of functionality

Mostly it will despatch to the mob that you are the owner of to actually move in the physical realm

Things that stop you moving as a mob:

world time being less than your next move_delay
not being in a mob, or that mob not having a loc
missing the n and direction parameters
being in remote control of an object (calls Moveobject instead)
being dead (it ghosts you instead)

Things that stop you moving as a mob living (why even have OO if you're just shoving it all in the parent proc with istype checks right?):

having incorporeal_move set (calls Process_Incorpmove() instead)
being grabbed
being buckled (relaymove() is called to the buckled atom instead)
having your loc be some other mob (relaymove() is called on that mob instead)
Not having MOBILITY_MOVE
Failing Process_Spacemove() call

At this point, if the mob is is confused, then a random direction and target turf will be calculated for you to travel to instead

Now the parent call is made (to the byond builtin move), which moves you

Some final move delay calculations (doubling if you moved diagonally successfully)

if mob throwing is set I believe it's unset at this point via a call to finalize

Finally if you're pulling an object and it's dense, you are turned 180 after the move (if you ask me, this should be at the top of the move so you don't dance around)

proc
Move_object
(direct)

force move the control_object of your client mob

Used in admin possession and called from the client Move proc ensures the possessed object moves and not the admin mob

Has no sanity other than checking density

proc
Process_Grab
()

Checks to see if you're being grabbed and if so attempts to break it

Called by client/Move()

proc
Process_Incorpmove
(direct)

Allows mobs to ignore density and phase through objects

Called by client/Move()

The behaviour depends on the incorporeal_move value of the mob

INCORPOREAL_MOVE_BASIC - forceMoved to the next tile with no stop
INCORPOREAL_MOVE_SHADOW - the same but leaves a cool effect path
INCORPOREAL_MOVE_JAUNT - the same but blocked by holy tiles

You'll note this is another mob living level proc living at the client level

proc
_Topic
(/datum/hsrc, href, /list/href_list)

dumb workaround because byond doesnt seem to recognize the PROC_REF(Topic()) typepath for /datum/proc/Topic() from the client Topic, so we cant queue it without this

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.

verb
body_chest
()

Hidden verb to target the chest, bound to 5

verb
body_groin
()

Hidden verb to target the groin, bound to 2

verb
body_l_arm
()

Hidden verb to target the left arm, bound to 6

verb
body_l_leg
()

Hidden verb to target the left leg, bound to 3

verb
body_r_arm
()

Hidden verb to target the right arm, bound to 4

verb
body_r_leg
()

Hidden verb to target the right leg, bound to 1

verb
body_toggle_head
()

Hidden verb to set the target zone of a mob to the head

(bound to 8) - repeated presses toggles through head - eyes - mouth

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
check_has_body_select
()

Validate the client's mob has a valid zone selected

proc
check_timer_sources
()

A debug verb to check the sources of currently running timers

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.

verb
drop_item
()

If your mob is concious, drop the item in the active hand

This is a hidden verb, likely for binding with winset for hotkeys

proc
edit_mentors
()

It's like permissions panel, but for mentors, also probably less secure, but honestly dude its mentors, not actual dangerous perms

proc
fax_panel
()

If client have R_ADMIN flag, opens an admin fax panel.

verb
fix_tgui_panel
()

tgui panel / chat troubleshooting verb

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 and sends it to the browser

proc
initialize_menus
()

Initializes dropdown menus on client

verb
keyUp
(_key)

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

proc
on_stat_panel_message
(type, payload)

Handles incoming messages from the stat-panel TGUI.

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.

proc
requests
()

Verb for opening the requests manager panel

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
send_resources
()

Send resources to the client. Sends both game resources and browser assets.

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.

verb
toggle_walk_run
()

Verb to toggle the walk or run status

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

client /client inherits /datum

Vars

Procs

Var Details

var AI_Interact –

var account_age –

var account_join_date –

var active_mousedown_item – /obj/item

var admin_music_volume –

var area –

var avgping –

var ban_cache –

var char_render_holders – /list

var click_intercept – /datum

var click_intercept_time –

var clicklimiter – /list

var client_keysend_amount –

var connection_realtime –

var connection_time –

var connection_timeofday –

var credits – /list

var crew_manifest_delay –

var dont_animate_parallax –

var externalreplyamount –

var holder – /datum/admins

var inprefs –

var interviewee –

var ip_intel –

var key_combos_held – /list

var keys_held – /list

var keysend_tripped –

var last_asset_job –

var last_completed_asset_job –

var last_message –

var last_message_count –

var last_parallax_shift –

var last_seen_afk –

var last_turn –

var lastping –

var mouseLocation –

var mouseObject –

var mouseParams –

var mouse_down_icon –

var mouse_override_icon –

var mouse_up_icon –

var move_delay –

var movement_keys – /list

var next_keysend_reset –

var next_keysend_trip_reset –

var next_move_dir_add –

var next_move_dir_sub –

var obj_window – /datum/object_window_info

var panel_tabs – /list

var parallax_throttle –

var player_age –

var player_details – /datum/player_details

var player_join_date –

var prefs – /datum/preferences

var recent_examines – /list

var related_accounts_cid –

var related_accounts_ip –

var say_slowmode –

var screen_maps – /list

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

var script –

var seen_messages – /list

var selected_target – /list/list/atom

var show_verb_panel –

var spell_tabs – /list

var stat_panel – /datum/tgui_window

var stat_tab –

var tgui_cache_reloaded –

var tgui_panel – /datum/tgui_panel

var tgui_windows – /list

var tooltips – /datum/tooltip

var topiclimiter – /list

var total_count_reset –

var total_message_count –

var view_size – /datum/viewData