Documents 61 files

code/__DEFINES/DNA.dm

@@ -91,9 +91,11 @@
 #define TR_KEEPITEMS	(1<<0)
 #define TR_KEEPVIRUS	(1<<1)
 #define TR_KEEPDAMAGE	(1<<2)
-#define TR_HASHNAME		(1<<3)	// hashing names (e.g. monkey(e34f)) (only in monkeyize)
+/// hashing names (e.g. monkey(e34f)) (only in monkeyize)
+#define TR_HASHNAME		(1<<3)
 #define TR_KEEPIMPLANTS	(1<<4)
-#define TR_KEEPSE		(1<<5)	// changelings shouldn't edit the DNA's SE when turning into a monkey
+/// changelings shouldn't edit the DNA's SE when turning into a monkey
+#define TR_KEEPSE		(1<<5)
 #define TR_DEFAULTMSG	(1<<6)
 #define TR_KEEPORGANS	(1<<8)
 #define TR_KEEPSTUNS	(1<<9)
@@ -111,18 +113,22 @@
 #define LIPS			5
 #define NOBLOOD			6
 #define NOTRANSSTING	7
-#define MUTCOLORS_PARTSONLY	8	//Used if we want the mutant colour to be only used by mutant bodyparts. Don't combine this with MUTCOLORS, or it will be useless.
+/// Used if we want the mutant colour to be only used by mutant bodyparts. Don't combine this with MUTCOLORS, or it will be useless.
+#define MUTCOLORS_PARTSONLY	8
 #define NOZOMBIE		9
-#define DIGITIGRADE		10	//Uses weird leg sprites. Optional for Lizards, required for ashwalkers. Don't give it to other races unless you make sprites for this (see human_parts_greyscale.dmi)
+/// Uses weird leg sprites. Optional for Lizards, required for ashwalkers. Don't give it to other races unless you make sprites for this (see human_parts_greyscale.dmi)
+#define DIGITIGRADE		10
 #define NO_UNDERWEAR	11
 #define NOLIVER			12
 #define NOSTOMACH		13
 #define NO_DNA_COPY     14
 #define DRINKSBLOOD		15
 #define NOFLASH			16
-#define DYNCOLORS		17 //Use this if you want to change the race's color without the player being able to pick their own color. AKA special color shifting
+/// Use this if you want to change the race's color without the player being able to pick their own color. AKA special color shifting
+#define DYNCOLORS		17
 #define AGENDER			18
-#define NOEYESPRITES	19 //Do not draw eyes or eyeless overlay
+/// Do not draw eyes or eyeless overlay
+#define NOEYESPRITES	19
 
 //organ slots
 #define ORGAN_SLOT_BRAIN "brain"
@@ -152,7 +158,8 @@
 //organ defines
 #define STANDARD_ORGAN_THRESHOLD 	100
 #define STANDARD_ORGAN_HEALING 		0.001
-#define STANDARD_ORGAN_DECAY		0.00222		//designed to fail organs when left to decay for ~15 minutes
+/// designed to fail organs when left to decay for ~15 minutes
+#define STANDARD_ORGAN_DECAY		0.00222
 
 //used for the can_chromosome var on mutations
 #define CHROMOSOME_NEVER 0

code/__DEFINES/_globals.dm

@@ -1,15 +1,15 @@
 //See also controllers/globals.dm
 
-//Creates a global initializer with a given InitValue expression, do not use
+/// Creates a global initializer with a given InitValue expression, do not use
 #define GLOBAL_MANAGED(X, InitValue)\
 /datum/controller/global_vars/proc/InitGlobal##X(){\
     ##X = ##InitValue;\
     gvars_datum_init_order += #X;\
 }
-//Creates an empty global initializer, do not use
+/// Creates an empty global initializer, do not use
 #define GLOBAL_UNMANAGED(X) /datum/controller/global_vars/proc/InitGlobal##X() { return; }
 
-//Prevents a given global from being VV'd
+/// Prevents a given global from being VV'd
 #ifndef TESTING
 #define GLOBAL_PROTECT(X)\
 /datum/controller/global_vars/InitGlobal##X(){\
@@ -20,41 +20,41 @@
 #define GLOBAL_PROTECT(X)
 #endif
 
-//Standard BYOND global, do not use
+/// Standard BYOND global, do not use
 #define GLOBAL_REAL_VAR(X) var/global/##X
 
-//Standard typed BYOND global, do not use
+/// Standard typed BYOND global, do not use
 #define GLOBAL_REAL(X, Typepath) var/global##Typepath/##X
 
-//Defines a global var on the controller, do not use
+/// Defines a global var on the controller, do not use
 #define GLOBAL_RAW(X) /datum/controller/global_vars/var/global##X
 
-//Create an untyped global with an initializer expression
+/// Create an untyped global with an initializer expression
 #define GLOBAL_VAR_INIT(X, InitValue) GLOBAL_RAW(/##X); GLOBAL_MANAGED(X, InitValue)
 
-//Create a global const var, do not use
+/// Create a global const var, do not use
 #define GLOBAL_VAR_CONST(X, InitValue) GLOBAL_RAW(/const/##X) = InitValue; GLOBAL_UNMANAGED(X)
 
-//Create a list global with an initializer expression
+/// Create a list global with an initializer expression
 #define GLOBAL_LIST_INIT(X, InitValue) GLOBAL_RAW(/list/##X); GLOBAL_MANAGED(X, InitValue)
 
-//Create a list global that is initialized as an empty list
+/// Create a list global that is initialized as an empty list
 #define GLOBAL_LIST_EMPTY(X) GLOBAL_LIST_INIT(X, list())
 
-// Create a typed list global with an initializer expression
+/// Create a typed list global with an initializer expression
 #define GLOBAL_LIST_INIT_TYPED(X, Typepath, InitValue) GLOBAL_RAW(/list##Typepath/X); GLOBAL_MANAGED(X, InitValue)
 
-// Create a typed list global that is initialized as an empty list
+/// Create a typed list global that is initialized as an empty list
 #define GLOBAL_LIST_EMPTY_TYPED(X, Typepath) GLOBAL_LIST_INIT_TYPED(X, Typepath, list())
 
-//Create a typed global with an initializer expression
+/// Create a typed global with an initializer expression
 #define GLOBAL_DATUM_INIT(X, Typepath, InitValue) GLOBAL_RAW(Typepath/##X); GLOBAL_MANAGED(X, InitValue)
 
-//Create an untyped null global
+/// Create an untyped null global
 #define GLOBAL_VAR(X) GLOBAL_RAW(/##X); GLOBAL_UNMANAGED(X)
 
-//Create a null global list
+/// Create a null global list
 #define GLOBAL_LIST(X) GLOBAL_RAW(/list/##X); GLOBAL_UNMANAGED(X)
 
-//Create an typed null global
+/// Create an typed null global
 #define GLOBAL_DATUM(X, Typepath) GLOBAL_RAW(Typepath/##X); GLOBAL_UNMANAGED(X)

code/__DEFINES/_protect.dm

@@ -1,3 +1,4 @@
+///Protects a datum from being VV'd
 #define GENERAL_PROTECT_DATUM(Path)\
 ##Path/can_vv_get(var_name){\
     return FALSE;\
@@ -7,4 +8,4 @@
 }\
 ##Path/CanProcCall(procname){\
     return FALSE;\
-}
+}

code/__DEFINES/_tick.dm

@@ -1,13 +1,23 @@
+/// Tick limit while running normally
 #define TICK_LIMIT_RUNNING 80
+/// Tick limit used to resume things in stoplag
 #define TICK_LIMIT_TO_RUN 70
+/// Tick limit for MC while running
 #define TICK_LIMIT_MC 70
+/// Tick limit while initializing
 #define TICK_LIMIT_MC_INIT_DEFAULT 98
 
-#define TICK_USAGE world.tick_usage //for general usage
-#define TICK_USAGE_REAL world.tick_usage    //to be used where the result isn't checked
+/// for general usage of tick_usage
+#define TICK_USAGE world.tick_usage
+/// to be used where the result isn't checked
+#define TICK_USAGE_REAL world.tick_usage
 
+/// Returns true if tick_usage is above the limit
 #define TICK_CHECK ( TICK_USAGE > Master.current_ticklimit )
+/// runs stoplag if tick_usage is above the limit
 #define CHECK_TICK ( TICK_CHECK ? stoplag() : 0 )
 
+/// Returns true if tick usage is above 95, for high priority usage
 #define TICK_CHECK_HIGH_PRIORITY ( TICK_USAGE > 95 )
+/// runs stoplag if tick_usage is above 95, for high priority usage
 #define CHECK_TICK_HIGH_PRIORITY ( TICK_CHECK_HIGH_PRIORITY? stoplag() : 0 )

code/__DEFINES/access.dm

@@ -1,21 +1,33 @@
-#define ACCESS_SECURITY 1 // Security equipment, security records, gulag item storage, secbots
-#define ACCESS_BRIG 2 // Brig cells+timers, permabrig, gulag+gulag shuttle, prisoner management console
-#define ACCESS_ARMORY 3 // Armory, gulag teleporter, execution chamber
-#define ACCESS_FORENSICS_LOCKERS 4 //Detective's office, forensics lockers, security+medical records
+// Security equipment, security records, gulag item storage, secbots
+#define ACCESS_SECURITY 1
+/// Brig cells+timers, permabrig, gulag+gulag shuttle, prisoner management console
+#define ACCESS_BRIG 2
+ /// Armory, gulag teleporter, execution chamber
+#define ACCESS_ARMORY 3
+///Detective's office, forensics lockers, security+medical records
+#define ACCESS_FORENSICS_LOCKERS 4
+/// Medical general access
 #define ACCESS_MEDICAL 5
+/// Morgue access
 #define ACCESS_MORGUE 6
-#define ACCESS_TOX 7 //R&D department, R&D console, burn chamber on some maps
-#define ACCESS_TOX_STORAGE 8 //Toxins storage, burn chamber on some maps
+/// R&D department, R&D console, burn chamber on some maps
+#define ACCESS_TOX 7
+/// Toxins storage, burn chamber on some maps
+#define ACCESS_TOX_STORAGE 8
+/// Genetics access
 #define ACCESS_GENETICS 9
-#define ACCESS_ENGINE 10 //Engineering area, power monitor, power flow control console
-#define ACCESS_ENGINE_EQUIP 11 //APCs, EngiVend/YouTool, engineering equipment lockers
+/// Engineering area, power monitor, power flow control console
+#define ACCESS_ENGINE 10
+///APCs, EngiVend/YouTool, engineering equipment lockers
+#define ACCESS_ENGINE_EQUIP 11
 #define ACCESS_MAINT_TUNNELS 12
 #define ACCESS_EXTERNAL_AIRLOCKS 13
 #define ACCESS_CHANGE_IDS 15
 #define ACCESS_AI_UPLOAD 16
 #define ACCESS_TELEPORTER 17
 #define ACCESS_EVA 18
-#define ACCESS_HEADS 19 //Bridge, EVA storage windoors, gateway shutters, AI integrity restorer, clone record deletion, comms console
+/// Bridge, EVA storage windoors, gateway shutters, AI integrity restorer, clone record deletion, comms console
+#define ACCESS_HEADS 19
 #define ACCESS_CAPTAIN 20
 #define ACCESS_ALL_PERSONAL_LOCKERS 21
 #define ACCESS_CHAPEL_OFFICE 22
@@ -49,47 +61,74 @@
 #define ACCESS_CE 56
 #define ACCESS_HOP 57
 #define ACCESS_HOS 58
-#define ACCESS_RC_ANNOUNCE 59 //Request console announcements
-#define ACCESS_KEYCARD_AUTH 60 //Used for events which require at least two people to confirm them
-#define ACCESS_TCOMSAT 61 // has access to the entire telecomms satellite / machinery
+/// Request console announcements
+#define ACCESS_RC_ANNOUNCE 59
+/// Used for events which require at least two people to confirm them
+#define ACCESS_KEYCARD_AUTH 60
+/// has access to the entire telecomms satellite / machinery
+#define ACCESS_TCOMSAT 61
 #define ACCESS_GATEWAY 62
-#define ACCESS_SEC_DOORS 63 // Outer brig doors, department security posts
-#define ACCESS_MINERAL_STOREROOM 64 //For releasing minerals from the ORM
+/// Outer brig doors, department security posts
+#define ACCESS_SEC_DOORS 63
+/// For releasing minerals from the ORM
+#define ACCESS_MINERAL_STOREROOM 64
 #define ACCESS_MINISAT 65
-#define ACCESS_WEAPONS 66 //Weapon authorization for secbots
-#define ACCESS_NETWORK 67 //NTnet diagnostics/monitoring software
-#define ACCESS_CLONING 68 //Cloning room and clone pod ejection
-#define ACCESS_PARAMEDIC 69 //Paramedic Office
-#define ACCESS_TCOM_ADMIN 70 // Access to the Signal Tech monitoring room
+/// Weapon authorization for secbots
+#define ACCESS_WEAPONS 66
+/// NTnet diagnostics/monitoring software
+#define ACCESS_NETWORK 67
+///Cloning room and clone pod ejection
+#define ACCESS_CLONING 68
+///Paramedic Office
+#define ACCESS_PARAMEDIC 69
+///Access to the Signal Tech monitoring room
+#define ACCESS_TCOM_ADMIN 70
 #define ACCESS_FREEMINER 71
 #define ACCESS_FREEMINER_CAPTAIN 72
 
 	//BEGIN CENTCOM ACCESS
 	/*Should leave plenty of room if we need to add more access levels.
 	Mostly for admin fun times.*/
-#define ACCESS_CENT_GENERAL 101//General facilities. CentCom ferry.
-#define ACCESS_CENT_THUNDER 102//Thunderdome.
-#define ACCESS_CENT_SPECOPS 103//Special Ops. Captain's display case, Marauder and Seraph mechs.
-#define ACCESS_CENT_MEDICAL 104//Medical/Research
-#define ACCESS_CENT_LIVING 105//Living quarters.
-#define ACCESS_CENT_STORAGE 106//Generic storage areas.
-#define ACCESS_CENT_TELEPORTER 107//Teleporter.
-#define ACCESS_CENT_CAPTAIN 109//Captain's office/ID comp/AI.
-#define ACCESS_CENT_BAR 110 // The non-existent CentCom Bar
+/// General facilities. CentCom ferry.
+#define ACCESS_CENT_GENERAL 101
+/// Thunderdome.
+#define ACCESS_CENT_THUNDER 102
+/// Special Ops. Captain's display case, Marauder and Seraph mechs.
+#define ACCESS_CENT_SPECOPS 103
+/// Medical/Research
+#define ACCESS_CENT_MEDICAL 104
+/// Living quarters.
+#define ACCESS_CENT_LIVING 105
+/// Generic storage areas.
+#define ACCESS_CENT_STORAGE 106
+/// Teleporter.
+#define ACCESS_CENT_TELEPORTER 107
+/// Captain's office/ID comp/AI.
+#define ACCESS_CENT_CAPTAIN 109
+/// The non-existent CentCom Bar
+#define ACCESS_CENT_BAR 110
 
 	//The Syndicate
-#define ACCESS_SYNDICATE 150//General Syndicate Access. Includes Syndicate mechs and ruins.
-#define ACCESS_SYNDICATE_LEADER 151//Nuke Op Leader Access
+/// General Syndicate Access. Includes Syndicate mechs and ruins.
+#define ACCESS_SYNDICATE 150
+/// Nuke Op Leader Access
+#define ACCESS_SYNDICATE_LEADER 151
 
 	//Away Missions or Ruins
 	/*For generic away-mission/ruin access. Why would normal crew have access to a long-abandoned derelict
 	or a 2000 year-old temple? */
-#define ACCESS_AWAY_GENERAL 200//General facilities.
-#define ACCESS_AWAY_MAINT 201//Away maintenance
-#define ACCESS_AWAY_MED 202//Away medical
-#define ACCESS_AWAY_SEC 203//Away security
-#define ACCESS_AWAY_ENGINE 204//Away engineering
-#define ACCESS_AWAY_GENERIC1 205//Away generic access
+/// Away general facilities.
+#define ACCESS_AWAY_GENERAL 200
+/// Away maintenance
+#define ACCESS_AWAY_MAINT 201
+/// Away medical
+#define ACCESS_AWAY_MED 202
+/// Away security
+#define ACCESS_AWAY_SEC 203
+/// Away engineering
+#define ACCESS_AWAY_ENGINE 204
+///Away generic access
+#define ACCESS_AWAY_GENERIC1 205
 #define ACCESS_AWAY_GENERIC2 206
 #define ACCESS_AWAY_GENERIC3 207
 #define ACCESS_AWAY_GENERIC4 208

code/__DEFINES/admin.dm

@@ -13,11 +13,13 @@
 #define BANTYPE_TEMP		2
 #define BANTYPE_JOB_PERMA	3
 #define BANTYPE_JOB_TEMP	4
-#define BANTYPE_ANY_FULLBAN	5 //used to locate stuff to unban.
+/// used to locate stuff to unban.
+#define BANTYPE_ANY_FULLBAN	5
 
 #define BANTYPE_ADMIN_PERMA	7
 #define BANTYPE_ADMIN_TEMP	8
-#define BANTYPE_ANY_JOB		9 //used to remove jobbans
+/// used to remove jobbans
+#define BANTYPE_ANY_JOB		9
 
 //Admin Permissions
 #define R_BUILDMODE		(1<<0)
@@ -78,14 +80,19 @@
 #define AHELP_CLOSED 2
 #define AHELP_RESOLVED 3
 
-#define ROUNDSTART_LOGOUT_REPORT_TIME	6000 //Amount of time (in deciseconds) after the rounds starts, that the player disconnect report is issued.
+/// Amount of time (in deciseconds) after the rounds starts, that the player disconnect report is issued.
+#define ROUNDSTART_LOGOUT_REPORT_TIME	6000
 
-#define SPAM_TRIGGER_WARNING	5	//Number of identical messages required before the spam-prevention will warn you to stfu
-#define SPAM_TRIGGER_AUTOMUTE	10	//Number of identical messages required before the spam-prevention will automute you
+/// Number of identical messages required before the spam-prevention will warn you to stfu
+#define SPAM_TRIGGER_WARNING	5
+/// Number of identical messages required before the spam-prevention will automute you
+#define SPAM_TRIGGER_AUTOMUTE	10
 
 #define STICKYBAN_DB_CACHE_TIME 10 SECONDS
 #define STICKYBAN_ROGUE_CHECK_TIME 5
 
 
-#define POLICY_POLYMORPH "polymorph" //Shown to vicitm of staff of change and related effects.
-#define POLICY_VERB_HEADER "policy_verb_header" //Shown on top of policy verb window
+/// Shown to vicitm of staff of change and related effects.
+#define POLICY_POLYMORPH "polymorph"
+/// Shown on top of policy verb window
+#define POLICY_VERB_HEADER "policy_verb_header"

code/__DEFINES/antagonists.dm

@@ -26,10 +26,12 @@
 
 
 //Blob
-#define BLOB_REROLL_TIME 2400 //blob gets a free reroll every X time
+/// blob gets a free reroll every X time
+#define BLOB_REROLL_TIME 2400
 #define BLOB_SPREAD_COST 4
-#define BLOB_ATTACK_REFUND 2 //blob refunds this much if it attacks and doesn't spread
-#define BLOB_REFLECTOR_COST 0 //yogs - reflectors are free
+/// blob refunds this much if it attacks and doesn't spread
+#define BLOB_ATTACK_REFUND 2
+#define BLOB_REFLECTOR_COST 15
 
 
 //ERT Types
@@ -47,11 +49,14 @@
 #define DEATHSQUAD_LEADER "ds_leader"
 
 //Shuttle hijacking
-#define HIJACK_NEUTRAL 0 //Does not stop hijacking but itself won't hijack
-#define HIJACK_HIJACKER 1 //Needs to be present for shuttle to be hijacked
-#define HIJACK_PREVENT 2 //Prevents hijacking same way as non-antags
+/// Does not stop hijacking but itself won't hijack
+#define HIJACK_NEUTRAL 0
+/// Needs to be present for shuttle to be hijacked
+#define HIJACK_HIJACKER 1
+/// Prevents hijacking same way as non-antags
+#define HIJACK_PREVENT 2
 
-//Overthrow time to update heads obj
+///Overthrow time to update heads obj
 #define OBJECTIVE_UPDATING_TIME 300
 
 //Assimilation