From a6aa03b90b60062b7d08e70f841eca7e34ed849c Mon Sep 17 00:00:00 2001 From: Rob Bailey Date: Sat, 14 Sep 2019 01:02:26 -0700 Subject: [PATCH] client vars autodoc (#46446) About The Pull Request Autodocs client vars --- code/modules/client/client_defines.dm | 77 +++++++++++++++++++-------- 1 file changed, 55 insertions(+), 22 deletions(-) diff --git a/code/modules/client/client_defines.dm b/code/modules/client/client_defines.dm index 70097a791a7..00e20fa2511 100644 --- a/code/modules/client/client_defines.dm +++ b/code/modules/client/client_defines.dm @@ -7,32 +7,45 @@ //////////////// //ADMIN THINGS// //////////////// + ///Contains admin info. Null if client is not an admin. var/datum/admins/holder = null - var/datum/click_intercept = null // Needs to implement InterceptClickOn(user,params,atom) proc - var/AI_Interact = 0 + ///Needs to implement InterceptClickOn(user,params,atom) proc + var/datum/click_intercept = null + ///Used for admin AI interaction + var/AI_Interact = FALSE - var/ban_cache = null //Used to cache this client's bans to save on DB queries - var/last_message = "" //Contains the last message sent by this client - used to protect against copy-paste spamming. - var/last_message_count = 0 //contins a number of how many times a message identical to last_message was sent. + ///Used to cache this client's bans to save on DB queries + var/ban_cache = null + ///Contains the last message sent by this client - used to protect against copy-paste spamming. + var/last_message = "" + ///contins a number of how many times a message identical to last_message was sent. + var/last_message_count = 0 ///How many messages sent in the last 10 seconds var/total_message_count = 0 ///Next tick to reset the total message counter var/total_count_reset = 0 + ///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/ircreplyamount = 0 ///////// //OTHER// ///////// + ///Player preferences datum for the client var/datum/preferences/prefs = null + ///last turn of the controlled mob, I think this is only used by mechs? var/last_turn = 0 + ///Move delay of controlled mob, related to input handling var/move_delay = 0 - var/area = null + ///Current area of the controlled mob + var/area = null /////////////// //SOUND STUFF// /////////////// - var/ambience_playing= null - var/played = 0 + ///Currently playing ambience sound + var/ambience_playing = null + ///Whether an ambience sound has been played and one shouldn't be played again, unset by a callback + var/played = FALSE //////////// //SECURITY// //////////// @@ -42,40 +55,60 @@ //////////////////////////////////// //things that require the database// //////////////////////////////////// - var/player_age = -1 //Used to determine how old the account is - in days. - var/player_join_date = null //Date that this account was first seen in the server - var/related_accounts_ip = "Requires database" //So admins know why it isn't working - Used to determine what other accounts previously logged in from this ip - var/related_accounts_cid = "Requires database" //So admins know why it isn't working - Used to determine what other accounts previously logged in from this computer id - var/account_join_date = null //Date of byond account creation in ISO 8601 format - var/account_age = -1 //Age of byond account in days + ///Used to determine how old the account is - in days. + var/player_age = -1 + ///Date that this account was first seen in the server + var/player_join_date = null + ///So admins know why it isn't working - Used to determine what other accounts previously logged in from this ip + var/related_accounts_ip = "Requires database" + ///So admins know why it isn't working - Used to determine what other accounts previously logged in from this computer id + var/related_accounts_cid = "Requires database" + ///Date of byond account creation in ISO 8601 format + var/account_join_date = null + ///Age of byond account in days + var/account_age = -1 preload_rsc = PRELOAD_RSC var/obj/screen/click_catcher/void - //These two vars are used to make a special mouse cursor, with a unique icon for clicking + ///used to make a special mouse cursor, this one for mouse up icon var/mouse_up_icon = null + ///used to make a special mouse cursor, this one for mouse up icon var/mouse_down_icon = null + ///Used for ip intel checking to identify evaders, disabled because of issues with traffic var/ip_intel = "Disabled" - //datum that controls the displaying and hiding of tooltips + ///datum that controls the displaying and hiding of tooltips var/datum/tooltip/tooltips + ///Last ping of the client var/lastping = 0 + ///Average ping of the client var/avgping = 0 - var/connection_time //world.time they connected - var/connection_realtime //world.realtime they connected - var/connection_timeofday //world.timeofday they connected + ///world.time they connected + var/connection_time + ///world.realtime they connected + var/connection_realtime + ///world.timeofday they connected + var/connection_timeofday + ///If the client is currently in player preferences var/inprefs = FALSE + ///Used for limiting the rate of topic sends by the client to avoid abuse var/list/topiclimiter + ///Used for limiting the rate of clicks sends by the client to avoid abuse var/list/clicklimiter + ///goonchat chatoutput of the client var/datum/chatOutput/chatOutput - var/list/credits //lazy list of all credit object bound to this client + ///lazy list of all credit object bound to this client + var/list/credits - var/datum/player_details/player_details //these persist between logins/logouts during the same round. + ///these persist between logins/logouts during the same round. + var/datum/player_details/player_details - var/list/char_render_holders //Should only be a key-value list of north/south/east/west = obj/screen. + ///Should only be a key-value list of north/south/east/west = obj/screen. + var/list/char_render_holders