datum

Vars
active_mousedown_item	Autoclick variable referencing the associated item.
admin_music_volume	Admin music volume, from 0 to 1.
autobunker_last_try	last time they tried to do an autobunker auth
block_parry_hinted	Should go in persistent round player data sometime. This tracks what items have already warned the user on pickup that they can block/parry.
click_catcher	Click catcher
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
completed_asset_jobs	List of all completed blocking send jobs awaiting acknowledgement by send_asset
credits	lazy list of all credit object bound to this client
cryo_warned	When was the last time we warned them about not cryoing without an ahelp, set to -5 minutes so that rounstart cryo still warns
holder	Contains admin info. Null if client is not an admin.
keys_held	Keys currently held
keysend_tripped	When set to true, user will be autokicked if they trip the keysends in a second limit again
last_activity	AFK tracking
last_asset_job	Last asset send job id.
last_click	Last time we Click()ed. No clicking twice in one tick!
last_macro_fix	Last time they used fix macros
mouseParams	Used in MouseDrag to preserve the original mouse click parameters
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
moused_over_objects	moused over objects, currently capped at 7. this is awful, and should be replaced with a component to track it using signals for parrying at some point.
movement_keys	custom movement keys for this client
navigation_images	Images of the path created by navigate().
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_mousemove	The next point in time at which the client is allowed to send a mousemove() or mousedrag()
next_move_dir_add	These next two vars are to apply movement for keypresses and releases made while move delayed. Because discarding that input makes the game less responsive. 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_holder	Parallax holder
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.
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_tab	our current tab
statbrowser_ready	whether our browser is ready or not yet
tgui_cache_reloaded	global
tgui_windows	global
tip_timer	Timers are now handled by clients, not by doing a mess on the item and multiple people overwriting a single timer on the object, have fun.
total_count_reset	Next tick to reset the total message counter
total_message_count	How many messages sent in the last 10 seconds
verb_tabs	list of tabs containing verbs
view_size	viewsize datum for holding our view size
Procs
ForceAllKeysUp	Keyup's all keys held down.
NONSENSICAL_VERB_THAT_DOES_NOTHING	*sigh
Process_Grab	Process_Grab(): checks for grab, attempts to break if so. Return TRUE to prevent movement.
Process_Incorpmove	Process_Incorpmove Called by client/Move() Allows mobs to run though walls
admin_cmd_remove_ghost_respawn_timer	Allows a ghost to bypass respawn delay without lifting respawn restrictions
admin_cmd_respawn_return_to_lobby	Fully returns a player to lobby, allowing them to bypass all respawn restrictions Works on ghosts or new players (lobby players) If a lobby player is selected, their restrictions are removed.
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.
award_heart	Redirect proc that makes it easier to get the status of an achievement. Achievement type is the typepath to the award.
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.
fix_tgui_panel	tgui panel / chat troubleshooting verb
forceEvent	Allows an admin to force an event
get_award_status	Redirect proc that makes it easier to get the status of an achievement. Achievement type is the typepath to the award.
give_award	Redirect proc that makes it easier to call the unlock achievement proc. Achievement type is the typepath to the award, user is the mob getting the award, and value is an optional variable used for leaderboard value increments
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
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.
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.
uiclose	verb
update_clickcatcher	Makes a clickcatcher if necessary, and ensures it's fit to our size.
update_special_keybinds	Updates the keybinds for special keys

Var Details

var
active_mousedown_item
– /obj/item

Autoclick variable referencing the associated item.

var
admin_music_volume
–

Admin music volume, from 0 to 1.

var
autobunker_last_try
–

last time they tried to do an autobunker auth

var
block_parry_hinted
– /list

Should go in persistent round player data sometime. This tracks what items have already warned the user on pickup that they can block/parry.

var
click_catcher
– /atom/movable/screen/click_catcher

Click catcher

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

List of all completed blocking send jobs awaiting acknowledgement by send_asset

var
credits
– /list

lazy list of all credit object bound to this client

var
cryo_warned
–

When was the last time we warned them about not cryoing without an ahelp, set to -5 minutes so that rounstart cryo still warns

var
holder
– /datum/admins

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

var
keys_held
– /list

Keys currently held

var
keysend_tripped
–

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

var
last_activity
–

AFK tracking

var
last_asset_job
–

Last asset send job id.

var
last_click
–

Last time we Click()ed. No clicking twice in one tick!

var
last_macro_fix
–

Last time they used fix macros

var
mouseParams
–

Used in MouseDrag to preserve the original mouse click parameters

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

moused over objects, currently capped at 7. this is awful, and should be replaced with a component to track it using signals for parrying at some point.

var
movement_keys
– /list

custom movement keys for this client

var
navigation_images
– /list

Images of the path created by navigate().

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

The next point in time at which the client is allowed to send a mousemove() or mousedrag()

var
next_move_dir_add
–

These next two vars are to apply movement for keypresses and releases made while move delayed. Because discarding that input makes the game less responsive. 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_holder
– /datum/parallax_holder

Parallax holder

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
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_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_windows
– /list

global

Tracks open windows for a user.

var
tip_timer
–

Timers are now handled by clients, not by doing a mess on the item and multiple people overwriting a single timer on the object, have fun.

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

list of tabs containing verbs

var
view_size
– /datum/view_data

viewsize datum for holding our view size

Proc Details

proc
ForceAllKeysUp
()

Keyup's all keys held down.

verb
NONSENSICAL_VERB_THAT_DOES_NOTHING
()

*sigh

proc
Process_Grab
()

Process_Grab(): checks for grab, attempts to break if so. Return TRUE to prevent movement.

proc
Process_Incorpmove
(direction)

Process_Incorpmove Called by client/Move() Allows mobs to run though walls

proc
admin_cmd_remove_ghost_respawn_timer
()

Allows a ghost to bypass respawn delay without lifting respawn restrictions

proc
admin_cmd_respawn_return_to_lobby
()

Fully returns a player to lobby, allowing them to bypass all respawn restrictions Works on ghosts or new players (lobby players) If a lobby player is selected, their restrictions are removed.

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
award_heart
(heart_reason)

Redirect proc that makes it easier to get the status of an achievement. Achievement type is the typepath to the award.

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.

verb
fix_tgui_panel
()

tgui panel / chat troubleshooting verb

proc
forceEvent
()

Allows an admin to force an event

proc
get_award_status
(achievement_type, /mob/user, value)

Redirect proc that makes it easier to get the status of an achievement. Achievement type is the typepath to the award.

proc
give_award
(achievement_type, /mob/user, value)

Redirect proc that makes it easier to call the unlock achievement proc. Achievement type is the typepath to the award, user is the mob getting the award, and value is an optional variable used for leaderboard value increments

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
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
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, 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
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_clickcatcher
(/list/view_override)

Makes a clickcatcher if necessary, and ensures it's fit to our size.

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

Returns list of special keybind in key = Mod1Mod2Mod3Key format, NOT Mod1+Mod2+Mod3+Key format.

client /client inherits /datum

Vars

Procs

Var Details

var active_mousedown_item – /obj/item

var admin_music_volume –

var autobunker_last_try –

var block_parry_hinted – /list

var click_catcher – /atom/movable/screen/click_catcher

var click_intercept_time –

var clicklimiter – /list

var client_keysend_amount –

var completed_asset_jobs – /list

var credits – /list

var cryo_warned –

var holder – /datum/admins

var keys_held – /list

var keysend_tripped –

var last_activity –

var last_asset_job –

var last_click –

var last_macro_fix –

var mouseParams –

var mouse_location_ref – /datum/weakref

var mouse_object_ref – /datum/weakref

var mouse_override_icon –

var moused_over_objects – /list

var movement_keys – /list

var navigation_images – /list

var next_keysend_reset –

var next_keysend_trip_reset –

var next_mousemove –

var next_move_dir_add –

var next_move_dir_sub –

var panel_tabs – /list

var parallax_holder – /datum/parallax_holder

var recent_examines – /list

var screen_maps – /list

var script –

var seen_messages – /list

var selected_target – /list/list/atom

var show_verb_panel –

var spell_tabs – /list

var stat_tab –

var statbrowser_ready –

var tgui_cache_reloaded –

var tgui_windows – /list

var tip_timer –

var total_count_reset –

var total_message_count –

var verb_tabs – /list

var view_size – /datum/view_data