datum

Vars
active_keybindings	The client's active keybindings, depending on their active mob.
admin_music_volume	Copyright (c) 2020 Aleksej Komarov SPDX-License-Identifier: MIT Admin music volume, from 0 to 1.
byondacc_age	Days since the client's BYOND account was created
byondacc_date	Date the client registered their BYOND account on
completed_asset_jobs	List of all completed blocking send jobs awaiting acknowledgement by send_asset
connection_time	world.time they connected
cui_entries	List of the clients CUIs
description_holders	Persistent storage for the flavour text of examined atoms.
input_data	Input datum, what the client is pressing.
jbh	The client's job ban holder
last_asset_job	Last asset send job id
last_discord_pm_time	Last world.time that a PM was send to discord by a player
movement_kb_dirs	The client's movement keybindings to directions, which work regardless of modifiers.
pai_save	Client's pAI save
received_discord_pm	Last world/time that a PM was sent to the player by an admin
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
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.
seen_messages	Messages currently seen by this client
sent_assets	List of all asset filenames sent to this client by the asset cache, along with their assoicated md5s
tgui_cache_reloaded	global
tgui_panel	Copyright (c) 2020 Aleksej Komarov SPDX-License-Identifier: MIT
tgui_windows	global
topiclimiter	Used for limiting the rate of topic sends by the client to avoid abuse
tos_consent	Has the client accepted the TOS about data collection and other stuff
version_blocked	If true, client cannot ready up, late join, or observe. Used for players with EXTREMELY old byond versions.
watchlisted	Is the client watchlisted
Procs
Key_Down	This list defines the keys in legacy mode that get passed on to the rebindable input system It cannot be bigger since, while typing, the keys would be passed to whatever they are set in the rebind input system
Process_Grab	Process_Grab() Called by client/Move() Checks to see if you are being grabbed and if so attemps to break it
Process_Incorpmove	Process_Incorpmove Called by client/Move() Allows mobs to run though walls
_Topic	dumb workaround because byond doesnt seem to recognize the Topic() typepath for /datum/proc/Topic() from the client Topic, so we cant queue it without this
admin_change_title_screen	Enables an admin to upload a new titlescreen image.
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_rs 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.
change_title_screen_html	An admin debug command that enables you to change the HTML on the go.
change_title_screen_notice	Sets a titlescreen notice, a big red text on the main screen.
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_eventmob_for	WARNING! The jobban stuff looks mangled and disgusting But it looks beautiful in-game -Nodrak WARNING!
create_popup	Creates a popup window with a basic map element in it, without any further initialization.
display_job_bans	Lists all active jobbans for src client
fix_tgui_panel	tgui panel / chat troubleshooting verb
fix_title_screen	Reloads the titlescreen if it is bugged for someone.
get_byond_account_date	Sets the clients BYOND date up properly
handle_popup_close	When the popup closes in any way (player or proc call) it calls this.
maxview	Returns the biggest number from client.view so we can do easier maths
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.
retrieve_byondacc_data	Retrieves the BYOND accounts data from the BYOND servers
set_macros	This proc sets the built in BYOND macros for keypresses to pass inputs on to the rebindable input system or the legacy system If you plan on ripping out the legacy system, see the set_macros() proc at the following commit: https://github.com/S34NW/Paradise/commit/83a0a0b0c633807cc5a88a630f623cec24e16027
setup_popup	Create the popup, and get it ready for generic use by giving it a background.
timer_log	Opens a log of timers
uiclose	verb
uid_log	Opens a log of UIDs

Var Details

var
active_keybindings
– /list

The client's active keybindings, depending on their active mob.

var
admin_music_volume
–

var
byondacc_age
–

Days since the client's BYOND account was created

var
byondacc_date
–

Date the client registered their BYOND account on

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
cui_entries
– /list/datum/custom_user_item

List of the clients CUIs

var
description_holders
– /list

Persistent storage for the flavour text of examined atoms.

var
input_data
– /datum/input_data

Input datum, what the client is pressing.

var
jbh
– /datum/job_ban_holder

The client's job ban holder

var
last_asset_job
–

Last asset send job id

var
last_discord_pm_time
–

Last world.time that a PM was send to discord by a player

var
movement_kb_dirs
– /list

The client's movement keybindings to directions, which work regardless of modifiers.

var
pai_save
– /datum/pai_save

Client's pAI save

var
received_discord_pm
–

Last world/time that a PM was sent to the player by an admin

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
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(/obj/screen))

var
seen_messages
– /list

Messages currently seen by this client

var
sent_assets
– /list

List of all asset filenames sent to this client by the asset cache, along with their assoicated md5s

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

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

var
tos_consent
–

Has the client accepted the TOS about data collection and other stuff

var
version_blocked
–

If true, client cannot ready up, late join, or observe. Used for players with EXTREMELY old byond versions.

var
watchlisted
–

Is the client watchlisted

Proc Details

verb
Key_Down
(_key)

This list defines the keys in legacy mode that get passed on to the rebindable input system It cannot be bigger since, while typing, the keys would be passed to whatever they are set in the rebind input system

proc
Process_Grab
()

Process_Grab() Called by client/Move() Checks to see if you are being grabbed and if so attemps to break it

proc
Process_Incorpmove
(direct)

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

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

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

proc
admin_change_title_screen
()

Enables an admin to upload a new titlescreen image.

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_rs 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
change_title_screen_html
()

An admin debug command that enables you to change the HTML on the go.

proc
change_title_screen_notice
()

Sets a titlescreen notice, a big red text on the main screen.

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_eventmob_for
(/mob/living/carbon/human/H, killthem)

WARNING!** The jobban stuff looks mangled and disgusting But it looks beautiful in-game -Nodrak **WARNING!

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
display_job_bans
(from_client_connection)

Lists all active jobbans for src client

from_client_connection - If true, user will not recieve any info in chat if they have no job bans, used when a player loads into to the lobby.

verb
fix_tgui_panel
()

tgui panel / chat troubleshooting verb

verb
fix_title_screen
()

Reloads the titlescreen if it is bugged for someone.

proc
get_byond_account_date
(notify)

Sets the clients BYOND date up properly

If the client does not have a saved BYOND account creation date, retrieve it from the website If they do have a saved date, use that from the DB, because this value will never change Arguments:

notify - Do we notify admins of this new accounts date

verb
handle_popup_close
(window_id)

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

proc
maxview
()

Returns the biggest number from client.view so we can do easier maths

proc
register_map_obj
(/obj/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
retrieve_byondacc_data
()

Retrieves the BYOND accounts data from the BYOND servers

Makes a web request to byond.com to retrieve the details for the BYOND account associated with the clients ckey. Returns the data in a parsed, associative list

proc
set_macros
()

This proc sets the built in BYOND macros for keypresses to pass inputs on to the rebindable input system or the legacy system If you plan on ripping out the legacy system, see the set_macros() proc at the following commit: https://github.com/S34NW/Paradise/commit/83a0a0b0c633807cc5a88a630f623cec24e16027

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

Opens a log of timers

In-round ability to view what has created a timer, and how many times a timer for that path has been created

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

Opens a log of UIDs

In-round ability to view what has created a UID, and how many times a UID for that path has been declared

client /client inherits /datum

Vars

Procs

Var Details

var active_keybindings – /list

var admin_music_volume –

var byondacc_age –

var byondacc_date –

var completed_asset_jobs – /list

var connection_time –

var cui_entries – /list/datum/custom_user_item

var description_holders – /list

var input_data – /datum/input_data

var jbh – /datum/job_ban_holder

var last_asset_job –

var last_discord_pm_time –

var movement_kb_dirs – /list

var pai_save – /datum/pai_save

var received_discord_pm –

var recent_examines – /list

var screen_maps – /list

var seen_messages – /list

var sent_assets – /list

var tgui_cache_reloaded –

var tgui_panel – /datum/tgui_panel

var tgui_windows – /list

var topiclimiter – /list

var tos_consent –

var version_blocked –

var watchlisted –

Proc Details

verb Key_Down(_key)

proc Process_Grab()

proc Process_Incorpmove(direct)

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

proc admin_change_title_screen()

proc asset_cache_confirm_arrival(job_id)

proc asset_cache_preload_data(data)

proc asset_cache_update_json()

proc browse_queue_flush(timeout)

proc change_title_screen_html()

proc change_title_screen_notice()

proc clear_all_maps()

proc clear_map(map_name)

proc close_popup(popup)

proc create_eventmob_for(/mob/living/carbon/human/H, killthem)

proc create_popup(name, ratiox, ratioy)

proc display_job_bans(from_client_connection)

verb fix_tgui_panel()

verb fix_title_screen()

proc get_byond_account_date(notify)

verb handle_popup_close(window_id)

proc maxview()

proc register_map_obj(/obj/screen/screen_obj)

proc retrieve_byondacc_data()

proc set_macros()

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

proc timer_log()

verb uiclose(window_id)

proc uid_log()