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
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
combo_hud_enabled	Whether or not this client has the combo HUD enabled
connection_realtime	world.realtime they connected
connection_time	world.time they connected
connection_timeofday	world.timeofday they connected
crew_manifest_delay	rate limiting for the crew manifest
do_parallax_animations	Do we want to do parallax animations at all? Exists to prevent laptop fires
dont_animate_parallax	world.time of when we can state animate()ing parallax again
holder	Contains admin info. Null if client is not an admin.
hotkeys	Whether or not this client has standard hotkeys enabled
ip_intel	Used for ip intel checking to identify evaders, disabled because of issues with traffic
ircreplyamount	Internal counter for clients sending irc relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.
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_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_turn	last turn of the controlled mob, I think this is only used by mechs?
lastping	Last ping of the client
mouse_down_icon	used to make a special mouse cursor, this one for mouse up icon
mouse_location_ref	Used in MouseDrag to preserve the last mouse-entered location. Weakref
mouse_object_ref	Used in MouseDrag to preserve the last mouse-entered object. Weakref
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
movement_locked	Are we locking our movement input?
movingmob	this is the last recorded client eye by SSparallax/fire()
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
panel_tabs	list of all tabs
parallax_animate_timer	Timer for the area directional animation
parallax_layers_max	How many parallax layers to show our client
parallax_movedir	Direction our current area wants to move parallax
pixel_shifting	Are we trying to pixel-shift
player_age	Used to determine how old the account is - in days.
player_details	lazy list of all credit object bound to this client 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 RECENT_EXAMINE_MAX_WINDOW (default 2) 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.
script	!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!HEY LISTEN!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
seen_messages	Messages currently seen by this client
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
statbrowser_ready	whether our browser is ready or not yet
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
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
add_system_note	Makes the server note a player
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_eyes	Hidden verb to target the eyes, bound to 7
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_mouth	Hidden verb to target the mouth, bound to 9
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_drag_proximity	Handles treating drags as clicks if they're within some conditions Does some other stuff adjacent to trying to figure out what the user actually "wanted" to click Returns TRUE if it caused a click, FALSE otherwise
check_has_body_select	Validate the client's mob has a valid zone selected
checkachievements	Verb for opening the achievement viewer
clear_all_maps	Clears all the maps of registered screen objects.
clear_map	Clears the map of registered screen objects.
clear_screen	Clears the client's screen, aside from ones that opt out
close_popup	Closes a popup.
cmd_admin_create_centcom_report	Verb to open the create command report window and send command reports.
cmd_change_command_name	Verb to change the global command name.
create_popup	Creates a popup window with a basic map element in it, without any further initialization.
debug_hallucination_weighted_list_per_type	Debug verb for getting the weight of each distinct type within the random_hallucination_weighted_list
debug_spell_requirements	Debug verb for seeing at a glance what all spells have as set requirements
drop_item	If your mob is conscious, drop the item in the active hand
dsay	Our current command name to swap back to after sending the report. The sound we're going to play on report.
fix_tgui_panel	tgui panel / chat troubleshooting verb
get_remaining_days	Checks if this client has met the days requirement passed in, or if they are exempt from it. Returns the number of days left, or 0.
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
is_drag_clickable	Does the logic for checking if a drag counts as a click or not Returns true if it does, false otherwise
load_json_admin_event	Loads JSON event
mfa_backup_query	Asks the user for their backup codes, then resets the login and re-enrolls the user on success
mfa_check	Checks the MFA for the client, then logs them in if they succeed Returns true if login successful, false otherwise The argument is TRUE if the user should be promted, false if not, useful for on login when the client may not be prepared for the query
mfa_check_cache	Check if the login from this location is from an existing session
mfa_enroll	Enrolls a user the in MFA system, assigning them a TOTP seed and backup code
mfa_query	Asks the user for their 2FA code
mfa_query_login	Queries the user for their MFA credentials, then logs them in if they are correct
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.
send_resources	Send resources to the client. Sends both game resources and browser assets.
set_tab	verbs that send information from the browser UI
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
wiki	THE GENESIS CALL

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

Whether or not this client has the combo HUD enabled

var
connection_realtime
–

world.realtime they connected

var
connection_time
–

world.time they connected

var
connection_timeofday
–

world.timeofday they connected

var
crew_manifest_delay
–

rate limiting for the crew manifest

var
do_parallax_animations
–

Do we want to do parallax animations at all? Exists to prevent laptop fires

var
dont_animate_parallax
–

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

var
holder
– /datum/admins

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

var
hotkeys
–

Whether or not this client has standard hotkeys enabled

var
ip_intel
–

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

var
ircreplyamount
–

Internal counter for clients sending irc relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.

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_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_turn
–

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

var
lastping
–

Last ping of the client

var
mouse_down_icon
–

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

var
mouse_location_ref
– /datum/weakref

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

var
mouse_object_ref
– /datum/weakref

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

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

Are we locking our movement input?

var
movingmob
– /atom/movable

this is the last recorded client eye by SSparallax/fire()

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
panel_tabs
– /list

list of all tabs

var
parallax_animate_timer
–

Timer for the area directional animation

var
parallax_layers_max
–

How many parallax layers to show our client

var
parallax_movedir
–

Direction our current area wants to move parallax

var
pixel_shifting
–

Are we trying to pixel-shift

var
player_age
–

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

var
player_details
– /datum/player_details

lazy list of all credit object bound to this client 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 RECENT_EXAMINE_MAX_WINDOW (default 2) 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
script
–

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

var
seen_messages
– /list

Messages currently seen by this client

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

whether our browser is ready or not yet

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

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
add_system_note
(system_ckey, message, avoid_duplicate)

Makes the server note a player

Automatically checks that we haven't noted them with the same system_ckey in the last day, and that their last note is not from that ckey either Arguments:

system_ckey The ckey of the server giving the note
message The actual message
avoid_duplicate Should we NEVER add a note with the same message?

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

Hidden verb to target the eyes, bound to 7

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

Hidden verb to target the mouth, bound to 9

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 Hidden verb to target the head, bound to 8

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_drag_proximity
(/atom/dragging, /atom/over, src_location, over_location, src_control, over_control, params)

Handles treating drags as clicks if they're within some conditions Does some other stuff adjacent to trying to figure out what the user actually "wanted" to click Returns TRUE if it caused a click, FALSE otherwise

proc
check_has_body_select
()

Validate the client's mob has a valid zone selected

verb
checkachievements
()

Verb for opening the achievement viewer

Opens the achievement browser for the given client, see /datum/achievement_browser

proc
clear_all_maps
()

Clears all the maps of registered screen objects.

proc
clear_map
(map_name)

Clears the map of registered screen objects.

proc
clear_screen
()

Clears the client's screen, aside from ones that opt out

proc
close_popup
(popup)

Closes a popup.

proc
cmd_admin_create_centcom_report
()

Verb to open the create command report window and send command reports.

proc
cmd_change_command_name
()

Verb to change the global command name.

proc
create_popup
(name, title, 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
debug_hallucination_weighted_list_per_type
()

Debug verb for getting the weight of each distinct type within the random_hallucination_weighted_list

proc
debug_spell_requirements
()

Debug verb for seeing at a glance what all spells have as set requirements

verb
drop_item
()

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

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

verb
dsay
(msg)

Our current command name to swap back to after sending the report. The sound we're going to play on report.

verb
fix_tgui_panel
()

tgui panel / chat troubleshooting verb

proc
get_remaining_days
(days_needed)

Checks if this client has met the days requirement passed in, or if they are exempt from it. Returns the number of days left, or 0.

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
is_drag_clickable
(/atom/dragging, /atom/over, params)

Does the logic for checking if a drag counts as a click or not Returns true if it does, false otherwise

proc
load_json_admin_event
()

Loads JSON event

proc
mfa_backup_query
()

Asks the user for their backup codes, then resets the login and re-enrolls the user on success

proc
mfa_check
(allow_query)

Checks the MFA for the client, then logs them in if they succeed Returns true if login successful, false otherwise The argument is TRUE if the user should be promted, false if not, useful for on login when the client may not be prepared for the query

proc
mfa_check_cache
()

Check if the login from this location is from an existing session

proc
mfa_enroll
()

Enrolls a user the in MFA system, assigning them a TOTP seed and backup code

proc
mfa_query
()

Asks the user for their 2FA code

proc
mfa_query_login
()

Queries the user for their MFA credentials, then logs them in if they are correct

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

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

verb
set_tab
(tab)

verbs that send information from the browser UI

proc
setup_popup
(popup_name, width, height, tilesize, title, 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

verb
wiki
(query)

THE GENESIS CALL

THE VERY FIRST LINE OF DM CODE TO EXECUTE Ong this must be done after !!!EVERYTHING!!! else NO IFS ANDS OR BUTS it's a hack, not an example of any sort, and DEFINITELY should NOT be emulated IT JUST HAS TO BE LAST!!!!!! If you want to do something in the initialization pipeline FIRST RTFM IN /code/game/world.dm AND THEN NEVER RETURN TO THIS PLACE

If you're still here, here's an explanation: BYOND loves to tell you about its loving spouse /global But it's actually having a sexy an affair with /static Specifically statics in procs Priority is given to these lines of code in REVERSE order of declaration in the .dme Which is why this file has a funky name So this is what we use to call world.Genesis() It's a nameless, no-op function, because it does absolutely nothing It exists to hold a static var which is initialized to null It's on /world to hide it from reflection Painful right? Good, now you share my suffering Please lock the door on your way out

/client inherits /datum

Vars

Procs

Var Details

var AI_Interact –

var account_age –

var account_join_date –

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

var connection_realtime –

var connection_time –

var connection_timeofday –

var crew_manifest_delay –

var do_parallax_animations –

var dont_animate_parallax –

var holder – /datum/admins

var hotkeys –

var ip_intel –

var ircreplyamount –

var key_combos_held – /list

var keys_held – /list

var last_message –

var last_message_count –

var last_turn –

var lastping –

var mouse_down_icon –

var mouse_location_ref – /datum/weakref

var mouse_object_ref – /datum/weakref

var mouse_override_icon –

var mouse_up_icon –

var move_delay –

var movement_keys – /list

var movement_locked –

var movingmob – /atom/movable

var next_move_dir_add –

var next_move_dir_sub –

var panel_tabs – /list

var parallax_animate_timer –

var parallax_layers_max –

var parallax_movedir –

var pixel_shifting –

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

var seen_messages – /list

var show_verb_panel –

var spell_tabs – /list

var stat_panel – /datum/tgui_window

var stat_tab –

var statbrowser_ready –

var tgui_cache_reloaded –

var tgui_panel – /datum/tgui_panel

var tgui_windows – /list

var tooltips – /datum/tooltip

var topiclimiter – /list