Browse Source

Deploy codedocs.tgstation13.org to github.com/tgstation/tgstation.git:gh-pages

gh-pages
Deployment Bot (from Travis CI) 1 year ago
commit
7b997609ce
  1. 0
      .nojekyll
  2. 1
      CNAME
  3. 414
      area.html
  4. 42
      area/space.html
  5. 1113
      atom.html
  6. 247
      atom/movable.html
  7. 32
      atom/movable/emissive_blocker.html
  8. 35
      atom/movable/lighting_object.html
  9. 698
      client.html
  10. 62
      code/__DEFINES/DNA.html
  11. 113
      code/__DEFINES/MC.html
  12. 123
      code/__DEFINES/_globals.html
  13. 33
      code/__DEFINES/_protect.html
  14. 87
      code/__DEFINES/_tick.html
  15. 214
      code/__DEFINES/access.html
  16. 87
      code/__DEFINES/admin.html
  17. 52
      code/__DEFINES/antagonists.html
  18. 455
      code/__DEFINES/atmospherics.html
  19. 122
      code/__DEFINES/atom_hud.html
  20. 32
      code/__DEFINES/callbacks.html
  21. 52
      code/__DEFINES/cleaning.html
  22. 90
      code/__DEFINES/combat.html
  23. 37
      code/__DEFINES/configuration.html
  24. 37
      code/__DEFINES/cult.html
  25. 83
      code/__DEFINES/dcs/flags.html
  26. 57
      code/__DEFINES/dcs/helpers.html
  27. 1336
      code/__DEFINES/dcs/signals.html
  28. 62
      code/__DEFINES/diseases.html
  29. 172
      code/__DEFINES/flags.html
  30. 47
      code/__DEFINES/hud.html
  31. 116
      code/__DEFINES/interaction_flags.html
  32. 57
      code/__DEFINES/inventory.html
  33. 238
      code/__DEFINES/lighting.html
  34. 59
      code/__DEFINES/machines.html
  35. 47
      code/__DEFINES/materials.html
  36. 33
      code/__DEFINES/maths.html
  37. 33
      code/__DEFINES/misc.html
  38. 74
      code/__DEFINES/mobs.html
  39. 42
      code/__DEFINES/nanites.html
  40. 37
      code/__DEFINES/obj_flags.html
  41. 72
      code/__DEFINES/research.html
  42. 32
      code/__DEFINES/say.html
  43. 136
      code/__DEFINES/subsystems.html
  44. 37
      code/__DEFINES/traits.html
  45. 53
      code/__HELPERS/_lists.html
  46. 29
      code/controllers/subsystem/materials.html
  47. 27
      code/controllers/subsystem/skills.html
  48. 30
      code/datums/components/README.html
  49. 37
      code/datums/components/edible.html
  50. 33
      code/datums/components/material_container.html
  51. 28
      code/datums/materials/_material.html
  52. 34
      code/datums/traits/negative.html
  53. 28
      code/game/atoms.html
  54. 73
      code/game/gamemodes/dynamic/readme.html
  55. 102
      code/game/machinery/computer/dna_console.html
  56. 40
      code/game/machinery/slotmachine.html
  57. 33
      code/game/objects/items/RSF.html
  58. 33
      code/game/objects/structures/kitchen_spike.html
  59. 33
      code/modules/atmospherics/environmental/LINDA_turf_tile.html
  60. 32
      code/modules/atmospherics/machinery/components/unary_devices/cryo.html
  61. 32
      code/modules/atmospherics/machinery/portable/canister.html
  62. 230
      code/modules/buildmode/README.html
  63. 36
      code/modules/clothing/spacesuits/hardsuit.html
  64. 60
      code/modules/keybindings/readme.html
  65. 61
      code/modules/language/language_holder.html
  66. 32
      code/modules/mining/aux_base.html
  67. 33
      code/modules/mining/minebot.html
  68. 32
      code/modules/mob/living/life.html
  69. 73
      code/modules/mob/living/simple_animal/friendly/drone/_drone.html
  70. 32
      code/modules/mob/living/simple_animal/hostile/megafauna/colossus.html
  71. 195
      code/modules/mob/say_readme.html
  72. 88
      code/modules/modular_computers/documentation.html
  73. 52
      code/modules/movespeed/_movespeed_modifier.html
  74. 32
      code/modules/power/supermatter/supermatter.html
  75. 269
      code/modules/reagents/chemistry/readme.html
  76. 37
      code/modules/reagents/chemistry/reagents/cat2_medicine_reagents.html
  77. 32
      code/modules/reagents/chemistry/reagents/other_reagents.html
  78. 38
      code/modules/recycling/disposal/multiz.html
  79. 436
      datum.html
  80. 71
      datum/AI_Module.html
  81. 92
      datum/achievement_data.html
  82. 49
      datum/action/changeling.html
  83. 35
      datum/action/cooldown/riot.html
  84. 57
      datum/action/innate/ai.html
  85. 43
      datum/action/innate/ai/ranged.html
  86. 43
      datum/action/innate/teleport_in.html
  87. 36
      datum/action/innate/teleport_self.html
  88. 50
      datum/action/item_action/agent_box.html
  89. 35
      datum/action/item_action/toggle_spacesuit.html
  90. 36
      datum/action/vehicle/ridden/scooter/skateboard/ollie.html
  91. 95
      datum/admins.html
  92. 49
      datum/antagonist.html
  93. 35
      datum/antagonist/changeling.html
  94. 44
      datum/antagonist/traitor.html
  95. 57
      datum/antagonist/traitor/contractor_support.html
  96. 78
      datum/award.html
  97. 127
      datum/blackmarket_item.html
  98. 71
      datum/blackmarket_market.html
  99. 57
      datum/blackmarket_purchase.html
  100. 57
      datum/bounty/pill.html

0
.nojekyll

1
CNAME

@ -0,0 +1 @@
codedocs.tgstation13.org

414
area.html

@ -0,0 +1,414 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;area - &#x2F;tg&#x2F; Station 13</title>
</head>
<body>
<header>
<a href="index.html">&#x2F;tg&#x2F; Station 13</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
&mdash; <a href="area.html#var">Var Details</a> - <a href="area.html#proc">Proc Details</a></header>
<main>
<h1>area <aside>/<a href="area.html">area</a></aside><aside> inherits /<a href="atom.html">atom</a></aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L6">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 6"/></a></h1>
<p>A grouping of tiles into a logical space, mostly used by map editors</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr>
<tr><th><a href="area.html#var/always_unpowered">always_unpowered</a></th><td>This gets overridden to 1 for space in area/Initialize().</td></tr>
<tr><th><a href="area.html#var/areasize">areasize</a></th><td>Size of the area in open turfs, only calculated for indoors areas.</td></tr>
<tr><th><a href="area.html#var/beauty">beauty</a></th><td>Beauty average per open turf in the area</td></tr>
<tr><th><a href="area.html#var/beauty_threshold">beauty_threshold</a></th><td>If a room is too big it doesn't have beauty.</td></tr>
<tr><th><a href="area.html#var/blob_allowed">blob_allowed</a></th><td>If blobs can spawn there and if it counts towards their score.</td></tr>
<tr><th><a href="area.html#var/canSmoothWithAreas">canSmoothWithAreas</a></th><td>typecache to limit the areas that atoms in this area can smooth with, used for shuttles IIRC</td></tr>
<tr><th><a href="area.html#var/flora_allowed">flora_allowed</a></th><td>If flora are allowed to spawn in this area randomly through tunnel generation</td></tr>
<tr><th><a href="area.html#var/hidden">hidden</a></th><td>Hides area from player Teleport function.</td></tr>
<tr><th><a href="area.html#var/map_name">map_name</a></th><td>Set in New(); preserves the name set by the map maker, even if renamed by the Blueprints.</td></tr>
<tr><th><a href="area.html#var/megafauna_spawn_allowed">megafauna_spawn_allowed</a></th><td>If megafauna can be spawned by natural random generation</td></tr>
<tr><th><a href="area.html#var/mob_spawn_allowed">mob_spawn_allowed</a></th><td>If mobs can be spawned by natural random generation</td></tr>
<tr><th><a href="area.html#var/mood_bonus">mood_bonus</a></th><td>Bonus mood for being in this area</td></tr>
<tr><th><a href="area.html#var/mood_message">mood_message</a></th><td>Mood message for being here, only shows up if mood_bonus != 0</td></tr>
<tr><th><a href="area.html#var/noteleport">noteleport</a></th><td>Are you forbidden from teleporting to the area? (centcom, mobs, wizard, hand teleporter)</td></tr>
<tr><th><a href="area.html#var/outdoors">outdoors</a></th><td>For space, the asteroid, lavaland, etc. Used with blueprints to determine if we are adding a new area (vs editing a station room)</td></tr>
<tr><th><a href="area.html#var/safe">safe</a></th><td>Is the area teleport-safe: no space / radiation / aggresive mobs / other dangers</td></tr>
<tr><th><a href="area.html#var/totalbeauty">totalbeauty</a></th><td>All beauty in this area combined, only includes indoor area.</td></tr>
<tr><th><a href="area.html#var/tunnel_allowed">tunnel_allowed</a></th><td>If mining tunnel generation is allowed in this area</td></tr>
<tr><th><a href="area.html#var/unique">unique</a></th><td>If false, loading multiple maps with this area type will create multiple instances.</td></tr>
<tr><th><a href="area.html#var/valid_territory">valid_territory</a></th><td>If it's a valid territory for cult summoning or the CRAB-17 phone to spawn</td></tr>
<tr><th><a href="area.html#var/xenobiology_compatible">xenobiology_compatible</a></th><td>Can the Xenobio management console transverse this area by default?</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr>
<tr><th><a href="area.html#proc/AllowDrop">AllowDrop</a></th><td>Causes a runtime error</td></tr>
<tr><th><a href="area.html#proc/Destroy">Destroy</a></th><td>Destroy an area and clean it up</td></tr>
<tr><th><a href="area.html#proc/Entered">Entered</a></th><td>Call back when an atom enters an area</td></tr>
<tr><th><a href="area.html#proc/Exited">Exited</a></th><td>Called when an atom exits an area</td></tr>
<tr><th><a href="area.html#proc/Initialize">Initialize</a></th><td>Initalize this area</td></tr>
<tr><th><a href="area.html#proc/LateInitialize">LateInitialize</a></th><td>Sets machine power levels in the area</td></tr>
<tr><th><a href="area.html#proc/ModifyFiredoors">ModifyFiredoors</a></th><td>Try to close all the firedoors in the area</td></tr>
<tr><th><a href="area.html#proc/New">New</a></th><td>Called when an area loads</td></tr>
<tr><th><a href="area.html#proc/PlaceOnTopReact">PlaceOnTopReact</a></th><td>A hook so areas can modify the incoming args (of what??)</td></tr>
<tr><th><a href="area.html#proc/addStaticPower">addStaticPower</a></th><td>Add a static amount of power load to an area</td></tr>
<tr><th><a href="area.html#proc/atmosalert">atmosalert</a></th><td>Generate an atmospheric alert for this area</td></tr>
<tr><th><a href="area.html#proc/burglaralert">burglaralert</a></th><td>Raise a burglar alert for this area</td></tr>
<tr><th><a href="area.html#proc/clear_usage">clear_usage</a></th><td>Clear all power usage in area</td></tr>
<tr><th><a href="area.html#proc/close_and_lock_door">close_and_lock_door</a></th><td>Close and lock a door passed into this proc</td></tr>
<tr><th><a href="area.html#proc/drop_location">drop_location</a></th><td>Causes a runtime error</td></tr>
<tr><th><a href="area.html#proc/firealert">firealert</a></th><td>Generate a firealarm alert for this area</td></tr>
<tr><th><a href="area.html#proc/firereset">firereset</a></th><td>Reset the firealarm alert for this area</td></tr>
<tr><th><a href="area.html#proc/power_change">power_change</a></th><td>Called when the area power status changes</td></tr>
<tr><th><a href="area.html#proc/poweralert">poweralert</a></th><td>Generate a power alert for this area</td></tr>
<tr><th><a href="area.html#proc/powered">powered</a></th><td>Returns int 1 or 0 if the area has power for the given channel</td></tr>
<tr><th><a href="area.html#proc/process">process</a></th><td>If 100 ticks has elapsed, toggle all the firedoors closed again</td></tr>
<tr><th><a href="area.html#proc/reg_in_areas_in_z">reg_in_areas_in_z</a></th><td>Register this area as belonging to a z level</td></tr>
<tr><th><a href="area.html#proc/set_fire_alarm_effect">set_fire_alarm_effect</a></th><td>Trigger the fire alarm visual affects in an area</td></tr>
<tr><th><a href="area.html#proc/setup">setup</a></th><td>Setup an area (with the given name)</td></tr>
<tr><th><a href="area.html#proc/unset_fire_alarm_effects">unset_fire_alarm_effects</a></th><td>unset the fire alarm visual affects in an area</td></tr>
<tr><th><a href="area.html#proc/update_areasize">update_areasize</a></th><td>Set the area size of the area</td></tr>
<tr><th><a href="area.html#proc/update_beauty">update_beauty</a></th><td>Divides total beauty in the room by roomsize to allow us to get an average beauty per tile.</td></tr>
<tr><th><a href="area.html#proc/update_icon_state">update_icon_state</a></th><td>Update the icon state of the area</td></tr>
<tr><th><a href="area.html#proc/use_power">use_power</a></th><td>Add a power value amount to the stored used_x variables</td></tr></table>
<h2 id="var">Var Details</h2><h3 id="var/always_unpowered"><aside class="declaration">var </aside>always_unpowered
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L48">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 48"/></a></h3>
<p>This gets overridden to 1 for space in area/Initialize().</p><h3 id="var/areasize"><aside class="declaration">var </aside>areasize
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L54">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 54"/></a></h3>
<p>Size of the area in open turfs, only calculated for indoors areas.</p><h3 id="var/beauty"><aside class="declaration">var </aside>beauty
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L42">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 42"/></a></h3>
<p>Beauty average per open turf in the area</p><h3 id="var/beauty_threshold"><aside class="declaration">var </aside>beauty_threshold
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L44">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 44"/></a></h3>
<p>If a room is too big it doesn't have beauty.</p><h3 id="var/blob_allowed"><aside class="declaration">var </aside>blob_allowed
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L22">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 22"/></a></h3>
<p>If blobs can spawn there and if it counts towards their score.</p><h3 id="var/canSmoothWithAreas"><aside class="declaration">var </aside>canSmoothWithAreas
<aside>&ndash; /list</aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L89">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 89"/></a></h3>
<p>typecache to limit the areas that atoms in this area can smooth with, used for shuttles IIRC</p><h3 id="var/flora_allowed"><aside class="declaration">var </aside>flora_allowed
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L27">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 27"/></a></h3>
<p>If flora are allowed to spawn in this area randomly through tunnel generation</p><h3 id="var/hidden"><aside class="declaration">var </aside>hidden
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L69">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 69"/></a></h3>
<p>Hides area from player Teleport function.</p><h3 id="var/map_name"><aside class="declaration">var </aside>map_name
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L17">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 17"/></a></h3>
<p>Set in New(); preserves the name set by the map maker, even if renamed by the Blueprints.</p><h3 id="var/megafauna_spawn_allowed"><aside class="declaration">var </aside>megafauna_spawn_allowed
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L31">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 31"/></a></h3>
<p>If megafauna can be spawned by natural random generation</p><h3 id="var/mob_spawn_allowed"><aside class="declaration">var </aside>mob_spawn_allowed
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L29">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 29"/></a></h3>
<p>If mobs can be spawned by natural random generation</p><h3 id="var/mood_bonus"><aside class="declaration">var </aside>mood_bonus
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L57">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 57"/></a></h3>
<p>Bonus mood for being in this area</p><h3 id="var/mood_message"><aside class="declaration">var </aside>mood_message
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L59">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 59"/></a></h3>
<p>Mood message for being here, only shows up if mood_bonus != 0</p><h3 id="var/noteleport"><aside class="declaration">var </aside>noteleport
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L67">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 67"/></a></h3>
<p>Are you forbidden from teleporting to the area? (centcom, mobs, wizard, hand teleporter)</p><h3 id="var/outdoors"><aside class="declaration">var </aside>outdoors
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L51">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 51"/></a></h3>
<p>For space, the asteroid, lavaland, etc. Used with blueprints to determine if we are adding a new area (vs editing a station room)</p><h3 id="var/safe"><aside class="declaration">var </aside>safe
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L71">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 71"/></a></h3>
<p>Is the area teleport-safe: no space / radiation / aggresive mobs / other dangers</p><h3 id="var/totalbeauty"><aside class="declaration">var </aside>totalbeauty
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L40">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 40"/></a></h3>
<p>All beauty in this area combined, only includes indoor area.</p><h3 id="var/tunnel_allowed"><aside class="declaration">var </aside>tunnel_allowed
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L25">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 25"/></a></h3>
<p>If mining tunnel generation is allowed in this area</p><h3 id="var/unique"><aside class="declaration">var </aside>unique
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L73">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 73"/></a></h3>
<p>If false, loading multiple maps with this area type will create multiple instances.</p><h3 id="var/valid_territory"><aside class="declaration">var </aside>valid_territory
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L20">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 20"/></a></h3>
<p>If it's a valid territory for cult summoning or the CRAB-17 phone to spawn</p><h3 id="var/xenobiology_compatible"><aside class="declaration">var </aside>xenobiology_compatible
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L87">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 87"/></a></h3>
<p>Can the Xenobio management console transverse this area by default?</p><h2 id="proc">Proc Details</h2><h3 id="proc/AllowDrop"><aside class="parent"><a title="/atom" href="atom.html#proc/AllowDrop">&uarr;</a></aside>AllowDrop<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L630">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 630"/></a></aside>
</h3>
<p>Causes a runtime error</p><h3 id="proc/Destroy"><aside class="parent"><a title="/atom" href="atom.html#proc/Destroy">&uarr;</a></aside>Destroy<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L211">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 211"/></a></aside>
</h3>
<p>Destroy an area and clean it up</p>
<p>Removes the area from GLOB.areas_by_type and also stops it processing on SSobj</p>
<p>This is despite the fact that no code appears to put it on SSobj, but
who am I to argue with old coders</p><h3 id="proc/Entered"><aside class="parent"><a title="/atom" href="atom.html#proc/Entered">&uarr;</a></aside>Entered<aside>(/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/M)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L547">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 547"/></a></aside>
</h3>
<p>Call back when an atom enters an area</p>
<p>Sends signals COMSIG_AREA_ENTERED and COMSIG_ENTER_AREA (to the atom)</p>
<p>If the area has ambience, then it plays some ambience music to the ambience channel</p><h3 id="proc/Exited"><aside class="parent"><a title="/atom" href="atom.html#proc/Exited">&uarr;</a></aside>Exited<aside>(/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/M)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L590">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 590"/></a></aside>
</h3>
<p>Called when an atom exits an area</p>
<p>Sends signals COMSIG_AREA_EXITED and COMSIG_EXIT_AREA (to the atom)</p><h3 id="proc/Initialize"><aside class="parent"><a title="/atom" href="atom.html#proc/Initialize">&uarr;</a></aside>Initialize<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L147">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 147"/></a></aside>
</h3>
<p>Initalize this area</p>
<p>intializes the dynamic area lighting and also registers the area with the z level via
reg_in_areas_in_z</p>
<p>returns INITIALIZE_HINT_LATELOAD</p><h3 id="proc/LateInitialize"><aside class="parent"><a title="/atom" href="atom.html#proc/LateInitialize">&uarr;</a></aside>LateInitialize<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L182">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 182"/></a></aside>
</h3>
<p>Sets machine power levels in the area</p><h3 id="proc/ModifyFiredoors"><aside class="declaration">proc </aside>ModifyFiredoors<aside>(opening)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L296">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 296"/></a></aside>
</h3>
<p>Try to close all the firedoors in the area</p><h3 id="proc/New"><aside class="parent"><a title="/atom" href="atom.html#proc/New">&uarr;</a></aside>New<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L131">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 131"/></a></aside>
</h3>
<p>Called when an area loads</p>
<p>Adds the item to the GLOB.areas_by_type list based on area type</p><h3 id="proc/PlaceOnTopReact"><aside class="declaration">proc </aside>PlaceOnTopReact<aside>(/list/new_baseturfs, /<a href="turf.html">turf</a>/fake_turf_type, flags)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L640">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 640"/></a></aside>
</h3>
<p>A hook so areas can modify the incoming args (of what??)</p><h3 id="proc/addStaticPower"><aside class="declaration">proc </aside>addStaticPower<aside>(value, powerchannel)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L517">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 517"/></a></aside>
</h3>
<p>Add a static amount of power load to an area</p>
<p>Possible channels
*AREA_USAGE_STATIC_EQUIP
*AREA_USAGE_STATIC_LIGHT
*AREA_USAGE_STATIC_ENVIRON</p><h3 id="proc/atmosalert"><aside class="declaration">proc </aside>atmosalert<aside>(danger_level, /<a href="obj.html">obj</a>/source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L258">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 258"/></a></aside>
</h3>
<p>Generate an atmospheric alert for this area</p>
<p>Sends to all ai players, alert consoles, drones and alarm monitor programs in the world</p><h3 id="proc/burglaralert"><aside class="declaration">proc </aside>burglaralert<aside>(/<a href="obj.html">obj</a>/trigger)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L403">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 403"/></a></aside>
</h3>
<p>Raise a burglar alert for this area</p>
<p>Close and locks all doors in the area and alerts silicon mobs of a break in</p>
<p>Alarm auto resets after 600 ticks</p><h3 id="proc/clear_usage"><aside class="declaration">proc </aside>clear_usage<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L527">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 527"/></a></aside>
</h3>
<p>Clear all power usage in area</p>
<p>Clears all power used for equipment, light and environment channels</p><h3 id="proc/close_and_lock_door"><aside class="declaration">proc </aside>close_and_lock_door<aside>(/<a href="obj.html">obj</a>/<a href="obj/machinery.html">machinery</a>/<a href="obj/machinery/door.html">door</a>/DOOR)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L390">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 390"/></a></aside>
</h3>
<p>Close and lock a door passed into this proc</p>
<p>Does this need to exist on area? probably not</p><h3 id="proc/drop_location"><aside class="parent"><a title="/atom" href="atom.html#proc/drop_location">&uarr;</a></aside>drop_location<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L636">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 636"/></a></aside>
</h3>
<p>Causes a runtime error</p><h3 id="proc/firealert"><aside class="declaration">proc </aside>firealert<aside>(/<a href="obj.html">obj</a>/source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L321">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 321"/></a></aside>
</h3>
<p>Generate a firealarm alert for this area</p>
<p>Sends to all ai players, alert consoles, drones and alarm monitor programs in the world</p>
<p>Also starts the area processing on SSobj</p><h3 id="proc/firereset"><aside class="declaration">proc </aside>firereset<aside>(/<a href="obj.html">obj</a>/source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L355">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 355"/></a></aside>
</h3>
<p>Reset the firealarm alert for this area</p>
<p>resets the alert sent to all ai players, alert consoles, drones and alarm monitor programs
in the world</p>
<p>Also cycles the icons of all firealarms and deregisters the area from processing on SSOBJ</p><h3 id="proc/power_change"><aside class="declaration">proc </aside>power_change<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L503">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 503"/></a></aside>
</h3>
<p>Called when the area power status changes</p>
<p>Updates the area icon and calls power change on all machinees in the area</p><h3 id="proc/poweralert"><aside class="declaration">proc </aside>poweralert<aside>(state, /<a href="obj.html">obj</a>/source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L222">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 222"/></a></aside>
</h3>
<p>Generate a power alert for this area</p>
<p>Sends to all ai players, alert consoles, drones and alarm monitor programs in the world</p><h3 id="proc/powered"><aside class="declaration">proc </aside>powered<aside>(chan)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L476">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 476"/></a></aside>
</h3>
<p>Returns int 1 or 0 if the area has power for the given channel</p>
<p>evalutes a mixture of variables mappers can set, requires_power, always_unpowered and then
per channel power_equip, power_light, power_environ</p><h3 id="proc/process">process<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L381">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 381"/></a></aside>
</h3>
<p>If 100 ticks has elapsed, toggle all the firedoors closed again</p><h3 id="proc/reg_in_areas_in_z"><aside class="declaration">proc </aside>reg_in_areas_in_z<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L191">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 191"/></a></aside>
</h3>
<p>Register this area as belonging to a z level</p>
<p>Ensures the item is added to the SSmapping.areas_in_z list for this z</p><h3 id="proc/set_fire_alarm_effect"><aside class="declaration">proc </aside>set_fire_alarm_effect<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L424">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 424"/></a></aside>
</h3>
<p>Trigger the fire alarm visual affects in an area</p>
<p>Updates the fire light on fire alarms in the area and sets all lights to emergency mode</p><h3 id="proc/setup"><aside class="declaration">proc </aside>setup<aside>(a_name)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L605">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 605"/></a></aside>
</h3>
<p>Setup an area (with the given name)</p>
<p>Sets the area name, sets all status var's to false and adds the area to the sorted area list</p><h3 id="proc/unset_fire_alarm_effects"><aside class="declaration">proc </aside>unset_fire_alarm_effects<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L438">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 438"/></a></aside>
</h3>
<p>unset the fire alarm visual affects in an area</p>
<p>Updates the fire light on fire alarms in the area and sets all lights to emergency mode</p><h3 id="proc/update_areasize"><aside class="declaration">proc </aside>update_areasize<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L620">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 620"/></a></aside>
</h3>
<p>Set the area size of the area</p>
<p>This is the number of open turfs in the area contents, or FALSE if the outdoors var is set</p><h3 id="proc/update_beauty"><aside class="declaration">proc </aside>update_beauty<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L575">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 575"/></a></aside>
</h3>
<p>Divides total beauty in the room by roomsize to allow us to get an average beauty per tile.</p><h3 id="proc/update_icon_state"><aside class="parent"><a title="/atom" href="atom.html#proc/update_icon_state">&uarr;</a></aside>update_icon_state<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L453">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 453"/></a></aside>
</h3>
<p>Update the icon state of the area</p>
<p>Im not sure what the heck this does, somethign to do with weather being able to set icon
states on areas?? where the heck would that even display?</p><h3 id="proc/use_power"><aside class="declaration">proc </aside>use_power<aside>(amount, chan)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L534">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 534"/></a></aside>
</h3>
<p>Add a power value amount to the stored used_x variables</p></main>
<footer>
tgstation.dme
<a href="https://github.com/tgstation/tgstation/tree/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3">3d3d7fc</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/src/dmdoc/README.md">dmdoc 1.2.1</a></footer>
</body>
</html>

42
area/space.html

@ -0,0 +1,42 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;area&#x2F;space - &#x2F;tg&#x2F; Station 13</title>
</head>
<body>
<header>
<a href="index.html">&#x2F;tg&#x2F; Station 13</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
&mdash; <a href="area/space.html#proc">Proc Details</a></header>
<main>
<h1>/<a href="area.html">area</a>/<a href="area/space.html">space</a>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/Space_Station_13_areas.dm#L23">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;Space_Station_13_areas.dm 23"/></a></h1>
<table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Procs</h2></td></tr>
<tr><th><a href="area/space.html#proc/powered">powered</a></th><td>Space is not powered ever, so this returns 0</td></tr>
<tr><th><a href="area/space.html#proc/update_icon_state">update_icon_state</a></th><td>Update the icon of the area (overridden to always be null for space</td></tr></table><h2 id="proc">Proc Details</h2><h3 id="proc/powered"><aside class="parent"><a title="/area" href="area.html#proc/powered">&uarr;</a></aside>powered<aside>(chan)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L495">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 495"/></a></aside>
</h3>
<p>Space is not powered ever, so this returns 0</p><h3 id="proc/update_icon_state"><aside class="parent"><a title="/area" href="area.html#proc/update_icon_state">&uarr;</a></aside>update_icon_state<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/area/areas.dm#L466">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 466"/></a></aside>
</h3>
<p>Update the icon of the area (overridden to always be null for space</p></main>
<footer>
tgstation.dme
<a href="https://github.com/tgstation/tgstation/tree/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3">3d3d7fc</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/src/dmdoc/README.md">dmdoc 1.2.1</a></footer>
</body>
</html>

1113
atom.html

File diff suppressed because it is too large

247
atom/movable.html

@ -0,0 +1,247 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;atom&#x2F;movable - &#x2F;tg&#x2F; Station 13</title>
</head>
<body>
<header>
<a href="index.html">&#x2F;tg&#x2F; Station 13</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
&mdash; <a href="atom/movable.html#var">Var Details</a> - <a href="atom/movable.html#proc">Proc Details</a></header>
<main>
<h1>/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L1">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 1"/></a></h1>
<table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr>
<tr><th><a href="atom/movable.html#var/blocks_emissive">blocks_emissive</a></th><td>Either FALSE, <a href="code/__DEFINES/lighting.html#define/EMISSIVE_BLOCK_GENERIC" title="EMISSIVE_BLOCK_GENERIC">EMISSIVE_BLOCK_GENERIC</a>, or <a href="code/__DEFINES/lighting.html#define/EMISSIVE_BLOCK_UNIQUE" title="EMISSIVE_BLOCK_UNIQUE">EMISSIVE_BLOCK_UNIQUE</a></td></tr>
<tr><th><a href="atom/movable.html#var/demo_last_loc">demo_last_loc</a></th><td>Last location of the atom for demo recording purposes</td></tr>
<tr><th><a href="atom/movable.html#var/em_block">em_block</a></th><td>Internal holder for emissive blocker object, do not use directly use blocks_emissive</td></tr>
<tr><th><a href="atom/movable.html#var/generic_canpass">generic_canpass</a></th><td>If false makes <a href="atom.html#proc/CanPass" title="/atom">CanPass</a> call <a href="atom/movable.html#proc/CanPassThrough" title="/atom/movable">CanPassThrough</a> on this type instead of using default behaviour</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr>
<tr><th><a href="atom/movable.html#proc/CanPassThrough">CanPassThrough</a></th><td>Returns true or false to allow src to move through the blocker, mover has final say</td></tr>
<tr><th><a href="atom/movable.html#proc/CanReach">CanReach</a></th><td>A backwards depth-limited breadth-first-search to see if the target is
logically &quot;in&quot; anything adjacent to us.</td></tr>
<tr><th><a href="atom/movable.html#proc/Process_Spacemove">Process_Spacemove</a></th><td>Called whenever an object moves and by mobs when they attempt to move themselves through space
And when an object or action applies a force on src, see <a href="atom/movable.html#proc/newtonian_move" title="/atom/movable">newtonian_move</a></td></tr>
<tr><th><a href="atom/movable.html#proc/add_blocked_language">add_blocked_language</a></th><td>Adds a language to the blocked language list. Use this over remove_language in cases where you will give languages back later.</td></tr>
<tr><th><a href="atom/movable.html#proc/attacked_by">attacked_by</a></th><td>Called from <a href="obj/item.html#proc/attack_obj" title="/obj/item">/obj/item/proc/attack_obj</a> and <a href="obj/item.html#proc/attack" title="/obj/item">/obj/item/proc/attack</a> if the attack succeeds</td></tr>
<tr><th><a href="atom/movable.html#proc/can_speak_language">can_speak_language</a></th><td>Checks if atom can speak the language.</td></tr>
<tr><th><a href="atom/movable.html#proc/copy_languages">copy_languages</a></th><td>Copies all languages into the supplied atom/language holder. Source should be overridden when you
do not want the language overwritten by later atom updates or want to avoid blocked languages.</td></tr>
<tr><th><a href="atom/movable.html#proc/could_speak_language">could_speak_language</a></th><td>Returns the result of tongue specific limitations on spoken languages.</td></tr>
<tr><th><a href="atom/movable.html#proc/get_language_holder">get_language_holder</a></th><td>Gets or creates the relevant language holder. For mindless atoms, gets the local one. For atom with mind, gets the mind one.</td></tr>
<tr><th><a href="atom/movable.html#proc/get_random_spoken_language">get_random_spoken_language</a></th><td>Gets a random spoken language, useful for forced speech and such.</td></tr>
<tr><th><a href="atom/movable.html#proc/get_random_understood_language">get_random_understood_language</a></th><td>Gets a random understood language, useful for hallucinations and such.</td></tr>
<tr><th><a href="atom/movable.html#proc/get_selected_language">get_selected_language</a></th><td>Returns selected language, if it can be spoken, or finds, sets and returns a new selected language if possible.</td></tr>
<tr><th><a href="atom/movable.html#proc/grant_all_languages">grant_all_languages</a></th><td>Grants every language.</td></tr>
<tr><th><a href="atom/movable.html#proc/grant_language">grant_language</a></th><td>Grants the supplied language and sets omnitongue true.</td></tr>
<tr><th><a href="atom/movable.html#proc/has_language">has_language</a></th><td>Checks if atom has the language. If spoken is true, only checks if atom can speak the language.</td></tr>
<tr><th><a href="atom/movable.html#proc/newtonian_move">newtonian_move</a></th><td>Only moves the object if it's under no gravity</td></tr>
<tr><th><a href="atom/movable.html#proc/on_enter_storage">on_enter_storage</a></th><td>called when this atom is added into a storage item, which is passed on as S. The loc variable is already set to the storage item.</td></tr>
<tr><th><a href="atom/movable.html#proc/on_exit_storage">on_exit_storage</a></th><td>called when this atom is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.</td></tr>
<tr><th><a href="atom/movable.html#proc/relay_container_resist">relay_container_resist</a></th><td>called when a mob resists while inside a container that is itself inside something.</td></tr>
<tr><th><a href="atom/movable.html#proc/remove_all_languages">remove_all_languages</a></th><td>Removes every language and sets omnitongue false.</td></tr>
<tr><th><a href="atom/movable.html#proc/remove_blocked_language">remove_blocked_language</a></th><td>Removes a language from the blocked language list.</td></tr>
<tr><th><a href="atom/movable.html#proc/remove_language">remove_language</a></th><td>Removes a single language.</td></tr>
<tr><th><a href="atom/movable.html#proc/setGrabState">setGrabState</a></th><td>Updates the grab state of the movable</td></tr>
<tr><th><a href="atom/movable.html#proc/throw_at">throw_at</a></th><td>If this returns FALSE then callback will not be called.</td></tr>
<tr><th><a href="atom/movable.html#proc/update_atom_languages">update_atom_languages</a></th><td>Empties out the atom specific languages and updates them according to the current atoms language holder.
As a side effect, it also creates missing language holders in the process.</td></tr></table>
<h2 id="var">Var Details</h2><h3 id="var/blocks_emissive"><aside class="declaration">var </aside>blocks_emissive
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L50">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 50"/></a></h3>
<p>Either FALSE, <a href="code/__DEFINES/lighting.html#define/EMISSIVE_BLOCK_GENERIC" title="EMISSIVE_BLOCK_GENERIC">EMISSIVE_BLOCK_GENERIC</a>, or <a href="code/__DEFINES/lighting.html#define/EMISSIVE_BLOCK_UNIQUE" title="EMISSIVE_BLOCK_UNIQUE">EMISSIVE_BLOCK_UNIQUE</a></p><h3 id="var/demo_last_loc"><aside class="declaration">var </aside>demo_last_loc
<aside>&ndash; /<a href="atom.html">atom</a></aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L47">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 47"/></a></h3>
<p>Last location of the atom for demo recording purposes</p><h3 id="var/em_block"><aside class="declaration">var </aside>em_block
<aside>&ndash; /<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/emissive_blocker.html">emissive_blocker</a></aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L55">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 55"/></a></h3>
<p>Internal holder for emissive blocker object, do not use directly use blocks_emissive</p><h3 id="var/generic_canpass"><aside class="declaration">var </aside>generic_canpass
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L29">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 29"/></a></h3>
<p>If false makes <a href="atom.html#proc/CanPass" title="/atom">CanPass</a> call <a href="atom/movable.html#proc/CanPassThrough" title="/atom/movable">CanPassThrough</a> on this type instead of using default behaviour</p><h2 id="proc">Proc Details</h2><h3 id="proc/CanPassThrough"><aside class="declaration">proc </aside>CanPassThrough<aside>(/<a href="atom.html">atom</a>/blocker, /<a href="turf.html">turf</a>/target, blocker_opinion)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L712">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 712"/></a></aside>
</h3>
<p>Returns true or false to allow src to move through the blocker, mover has final say</p><h3 id="proc/CanReach"><aside class="declaration">proc </aside>CanReach<aside>(/<a href="atom.html">atom</a>/ultimate_target, /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/tool, view_only)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/_onclick/click.dm#L185">
<img src="git.png" width="16" height="16" title="code&#x2F;_onclick&#x2F;click.dm 185"/></a></aside>
</h3>
<p>A backwards depth-limited breadth-first-search to see if the target is
logically &quot;in&quot; anything adjacent to us.</p><h3 id="proc/Process_Spacemove"><aside class="declaration">proc </aside>Process_Spacemove<aside>(movement_dir)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L538">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 538"/></a></aside>
</h3>
<p>Called whenever an object moves and by mobs when they attempt to move themselves through space
And when an object or action applies a force on src, see <a href="atom/movable.html#proc/newtonian_move" title="/atom/movable">newtonian_move</a></p>
<p>Return 0 to have src start/keep drifting in a no-grav area and 1 to stop/not start drifting</p>
<p>Mobs should return 1 if they should be able to move of their own volition, see <a href="client.html" title="/client">/client/Move</a></p>
<p>Arguments:</p>
<ul>
<li>movement_dir - 0 when stopping or any dir when trying to move</li>
</ul><h3 id="proc/add_blocked_language"><aside class="declaration">proc </aside>add_blocked_language<aside>(language, source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L867">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 867"/></a></aside>
</h3>
<p>Adds a language to the blocked language list. Use this over remove_language in cases where you will give languages back later.</p><h3 id="proc/attacked_by"><aside class="declaration">proc </aside>attacked_by<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/_onclick/item_attack.dm#L119">
<img src="git.png" width="16" height="16" title="code&#x2F;_onclick&#x2F;item_attack.dm 119"/></a></aside>
</h3>
<p>Called from <a href="obj/item.html#proc/attack_obj" title="/obj/item">/obj/item/proc/attack_obj</a> and <a href="obj/item.html#proc/attack" title="/obj/item">/obj/item/proc/attack</a> if the attack succeeds</p><h3 id="proc/can_speak_language"><aside class="declaration">proc </aside>can_speak_language<aside>(language)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L882">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 882"/></a></aside>
</h3>
<p>Checks if atom can speak the language.</p><h3 id="proc/copy_languages"><aside class="declaration">proc </aside>copy_languages<aside>(from_holder, source_override)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L907">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 907"/></a></aside>
</h3>
<p>Copies all languages into the supplied atom/language holder. Source should be overridden when you
do not want the language overwritten by later atom updates or want to avoid blocked languages.</p><h3 id="proc/could_speak_language"><aside class="declaration">proc </aside>could_speak_language<aside>(language)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L887">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 887"/></a></aside>
</h3>
<p>Returns the result of tongue specific limitations on spoken languages.</p><h3 id="proc/get_language_holder"><aside class="declaration">proc </aside>get_language_holder<aside>(get_minds)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L841">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 841"/></a></aside>
</h3>
<p>Gets or creates the relevant language holder. For mindless atoms, gets the local one. For atom with mind, gets the mind one.</p><h3 id="proc/get_random_spoken_language"><aside class="declaration">proc </aside>get_random_spoken_language<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L901">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 901"/></a></aside>
</h3>
<p>Gets a random spoken language, useful for forced speech and such.</p><h3 id="proc/get_random_understood_language"><aside class="declaration">proc </aside>get_random_understood_language<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L896">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 896"/></a></aside>
</h3>
<p>Gets a random understood language, useful for hallucinations and such.</p><h3 id="proc/get_selected_language"><aside class="declaration">proc </aside>get_selected_language<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L891">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 891"/></a></aside>
</h3>
<p>Returns selected language, if it can be spoken, or finds, sets and returns a new selected language if possible.</p><h3 id="proc/grant_all_languages"><aside class="declaration">proc </aside>grant_all_languages<aside>(understood, spoken, grant_omnitongue, source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L852">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 852"/></a></aside>
</h3>
<p>Grants every language.</p><h3 id="proc/grant_language"><aside class="declaration">proc </aside>grant_language<aside>(language, understood, spoken, source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L847">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 847"/></a></aside>
</h3>
<p>Grants the supplied language and sets omnitongue true.</p><h3 id="proc/has_language"><aside class="declaration">proc </aside>has_language<aside>(language, spoken)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L877">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 877"/></a></aside>
</h3>
<p>Checks if atom has the language. If spoken is true, only checks if atom can speak the language.</p><h3 id="proc/newtonian_move"><aside class="declaration">proc </aside>newtonian_move<aside>(direction)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L558">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 558"/></a></aside>
</h3>
<p>Only moves the object if it's under no gravity</p><h3 id="proc/on_enter_storage"><aside class="declaration">proc </aside>on_enter_storage<aside>(/<a href="datum.html">datum</a>/<a href="datum/component.html">component</a>/storage/concrete/S)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L722">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 722"/></a></aside>
</h3>
<p>called when this atom is added into a storage item, which is passed on as S. The loc variable is already set to the storage item.</p><h3 id="proc/on_exit_storage"><aside class="declaration">proc </aside>on_exit_storage<aside>(/<a href="datum.html">datum</a>/<a href="datum/component.html">component</a>/storage/concrete/S)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L718">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 718"/></a></aside>
</h3>
<p>called when this atom is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.</p><h3 id="proc/relay_container_resist"><aside class="declaration">proc </aside>relay_container_resist<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/user, /<a href="obj.html">obj</a>/O)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L745">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 745"/></a></aside>
</h3>
<p>called when a mob resists while inside a container that is itself inside something.</p><h3 id="proc/remove_all_languages"><aside class="declaration">proc </aside>remove_all_languages<aside>(source, remove_omnitongue)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L862">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 862"/></a></aside>
</h3>
<p>Removes every language and sets omnitongue false.</p><h3 id="proc/remove_blocked_language"><aside class="declaration">proc </aside>remove_blocked_language<aside>(language, source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L872">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 872"/></a></aside>
</h3>
<p>Removes a language from the blocked language list.</p><h3 id="proc/remove_language"><aside class="declaration">proc </aside>remove_language<aside>(language, understood, spoken, source)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L857">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 857"/></a></aside>
</h3>
<p>Removes a single language.</p><h3 id="proc/setGrabState"><aside class="declaration">proc </aside>setGrabState<aside>(newstate)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L946">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 946"/></a></aside>
</h3>
<p>Updates the grab state of the movable</p>
<p>This exists to act as a hook for behaviour</p><h3 id="proc/throw_at"><aside class="declaration">proc </aside>throw_at<aside>(/<a href="atom.html">atom</a>/target, range, speed, /<a href="mob.html">mob</a>/thrower, spin, diagonals_first, /<a href="datum.html">datum</a>/<a href="datum/callback.html">callback</a>/callback, force, gentle, quickstart)
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L591">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 591"/></a></aside>
</h3>
<p>If this returns FALSE then callback will not be called.</p><h3 id="proc/update_atom_languages"><aside class="declaration">proc </aside>update_atom_languages<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/game/atoms_movable.dm#L916">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;atoms_movable.dm 916"/></a></aside>
</h3>
<p>Empties out the atom specific languages and updates them according to the current atoms language holder.
As a side effect, it also creates missing language holders in the process.</p></main>
<footer>
tgstation.dme
<a href="https://github.com/tgstation/tgstation/tree/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3">3d3d7fc</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/src/dmdoc/README.md">dmdoc 1.2.1</a></footer>
</body>
</html>

32
atom/movable/emissive_blocker.html

@ -0,0 +1,32 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;atom&#x2F;movable&#x2F;emissive_blocker - &#x2F;tg&#x2F; Station 13</title>
</head>
<body>
<header>
<a href="index.html">&#x2F;tg&#x2F; Station 13</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
</header>
<main>
<h1>/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/emissive_blocker.html">emissive_blocker</a>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/lighting/emissive_blocker.dm#L9">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;lighting&#x2F;emissive_blocker.dm 9"/></a></h1>
<p>Internal atom that copies an appearance on to the blocker plane</p>
<p>Copies an appearance vis render_target and render_source on to the emissive blocking plane.
This means that the atom in question will block any emissive sprites.
This should only be used internally. If you are directly creating more of these, you're
almost guaranteed to be doing something wrong.</p></main>
<footer>
tgstation.dme
<a href="https://github.com/tgstation/tgstation/tree/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3">3d3d7fc</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/src/dmdoc/README.md">dmdoc 1.2.1</a></footer>
</body>
</html>

35
atom/movable/lighting_object.html

@ -0,0 +1,35 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;atom&#x2F;movable&#x2F;lighting_object - &#x2F;tg&#x2F; Station 13</title>
</head>
<body>
<header>
<a href="index.html">&#x2F;tg&#x2F; Station 13</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
&mdash; <a href="atom/movable/lighting_object.html#proc">Proc Details</a></header>
<main>
<h1>/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/lighting_object.html">lighting_object</a>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/lighting/lighting_object.dm#L1">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;lighting&#x2F;lighting_object.dm 1"/></a></h1>
<table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Procs</h2></td></tr>
<tr><th><a href="atom/movable/lighting_object.html#proc/onShuttleMove">onShuttleMove</a></th><td>Misc move procs</td></tr></table><h2 id="proc">Proc Details</h2><h3 id="proc/onShuttleMove">onShuttleMove<aside>()
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/shuttle/on_move.dm#L362">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;shuttle&#x2F;on_move.dm 362"/></a></aside>
</h3>
<p>Misc move procs</p></main>
<footer>
tgstation.dme
<a href="https://github.com/tgstation/tgstation/tree/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3">3d3d7fc</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/src/dmdoc/README.md">dmdoc 1.2.1</a></footer>
</body>
</html>

698
client.html

@ -0,0 +1,698 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;client - &#x2F;tg&#x2F; Station 13</title>
</head>
<body>
<header>
<a href="index.html">&#x2F;tg&#x2F; Station 13</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
&mdash; <a href="client.html#var">Var Details</a> - <a href="client.html#proc">Proc Details</a></header>
<main>
<h1>/<a href="client.html">client</a><aside> inherits /<a href="datum.html">datum</a></aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/_onclick/hud/map_popups.dm#L1">
<img src="git.png" width="16" height="16" title="code&#x2F;_onclick&#x2F;hud&#x2F;map_popups.dm 1"/></a></h1>
<table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr>
<tr><th><a href="client.html#var/AI_Interact">AI_Interact</a></th><td>Used for admin AI interaction</td></tr>
<tr><th><a href="client.html#var/account_age">account_age</a></th><td>Age of byond account in days</td></tr>
<tr><th><a href="client.html#var/account_join_date">account_join_date</a></th><td>Date of byond account creation in ISO 8601 format</td></tr>
<tr><th><a href="client.html#var/active_mousedown_item">active_mousedown_item</a></th><td>Autoclick variable referencing the associated item.</td></tr>
<tr><th><a href="client.html#var/ambience_playing">ambience_playing</a></th><td>Currently playing ambience sound</td></tr>
<tr><th><a href="client.html#var/area">area</a></th><td>Current area of the controlled mob</td></tr>
<tr><th><a href="client.html#var/avgping">avgping</a></th><td>Average ping of the client</td></tr>
<tr><th><a href="client.html#var/ban_cache">ban_cache</a></th><td>Used to cache this client's bans to save on DB queries</td></tr>
<tr><th><a href="client.html#var/char_render_holders">char_render_holders</a></th><td>Should only be a key-value list of north/south/east/west = obj/screen.</td></tr>
<tr><th><a href="client.html#var/chatOutput">chatOutput</a></th><td>goonchat chatoutput of the client</td></tr>
<tr><th><a href="client.html#var/click_intercept">click_intercept</a></th><td>Needs to implement InterceptClickOn(user,params,atom) proc</td></tr>
<tr><th><a href="client.html#var/clicklimiter">clicklimiter</a></th><td>Used for limiting the rate of clicks sends by the client to avoid abuse</td></tr>
<tr><th><a href="client.html#var/client_keysend_amount">client_keysend_amount</a></th><td>Amount of keydowns in the last keysend checking interval</td></tr>
<tr><th><a href="client.html#var/connection_realtime">connection_realtime</a></th><td>world.realtime they connected</td></tr>
<tr><th><a href="client.html#var/connection_time">connection_time</a></th><td>world.time they connected</td></tr>
<tr><th><a href="client.html#var/connection_timeofday">connection_timeofday</a></th><td>world.timeofday they connected</td></tr>
<tr><th><a href="client.html#var/credits">credits</a></th><td>lazy list of all credit object bound to this client</td></tr>
<tr><th><a href="client.html#var/current_key_address">current_key_address</a></th><td>used to keep track of the current rolling buffer position</td></tr>
<tr><th><a href="client.html#var/externalreplyamount">externalreplyamount</a></th><td>Internal counter for clients sending external (IRC/Discord) relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.</td></tr>
<tr><th><a href="client.html#var/holder">holder</a></th><td>Contains admin info. Null if client is not an admin.</td></tr>
<tr><th><a href="client.html#var/inprefs">inprefs</a></th><td>If the client is currently in player preferences</td></tr>
<tr><th><a href="client.html#var/ip_intel">ip_intel</a></th><td>Used for ip intel checking to identify evaders, disabled because of issues with traffic</td></tr>
<tr><th><a href="client.html#var/keys_held">keys_held</a></th><td>A rolling buffer of any keys held currently</td></tr>
<tr><th><a href="client.html#var/keysend_tripped">keysend_tripped</a></th><td>When set to true, user will be autokicked if they trip the keysends in a second limit again</td></tr>
<tr><th><a href="client.html#var/last_asset_job">last_asset_job</a></th><td>List of all completed blocking send jobs awaiting acknowledgement by send_asset</td></tr>
<tr><th><a href="client.html#var/last_completed_asset_job">last_completed_asset_job</a></th><td>Last asset send job id.</td></tr>
<tr><th><a href="client.html#var/last_message">last_message</a></th><td>Contains the last message sent by this client - used to protect against copy-paste spamming.</td></tr>
<tr><th><a href="client.html#var/last_message_count">last_message_count</a></th><td>contins a number of how many times a message identical to last_message was sent.</td></tr>
<tr><th><a href="client.html#var/last_turn">last_turn</a></th><td>last turn of the controlled mob, I think this is only used by mechs?</td></tr>
<tr><th><a href="client.html#var/lastping">lastping</a></th><td>Last ping of the client</td></tr>
<tr><th><a href="client.html#var/mouseLocation">mouseLocation</a></th><td>Used in MouseDrag to preserve the last mouse-entered location.</td></tr>
<tr><th><a href="client.html#var/mouseObject">mouseObject</a></th><td>Used in MouseDrag to preserve the last mouse-entered object.</td></tr>
<tr><th><a href="client.html#var/mouseParams">mouseParams</a></th><td>Used in MouseDrag to preserve the original mouse click parameters</td></tr>
<tr><th><a href="client.html#var/mouse_down_icon">mouse_down_icon</a></th><td>used to make a special mouse cursor, this one for mouse up icon</td></tr>
<tr><th><a href="client.html#var/mouse_up_icon">mouse_up_icon</a></th><td>used to make a special mouse cursor, this one for mouse up icon</td></tr>
<tr><th><a href="client.html#var/move_delay">move_delay</a></th><td>Move delay of controlled mob, related to input handling</td></tr>
<tr><th><a href="client.html#var/movement_keys">movement_keys</a></th><td>custom movement keys for this client</td></tr>
<tr><th><a href="client.html#var/next_keysend_reset">next_keysend_reset</a></th><td>World tick time where client_keysend_amount will reset</td></tr>
<tr><th><a href="client.html#var/next_keysend_trip_reset">next_keysend_trip_reset</a></th><td>World tick time where keysend_tripped will reset back to false</td></tr>
<tr><th><a href="client.html#var/next_move_dir_add">next_move_dir_add</a></th><td>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</td></tr>
<tr><th><a href="client.html#var/next_move_dir_sub">next_move_dir_sub</a></th><td>On next move, subtract this dir from the move that would otherwise be done</td></tr>
<tr><th><a href="client.html#var/played">played</a></th><td>Whether an ambience sound has been played and one shouldn't be played again, unset by a callback</td></tr>
<tr><th><a href="client.html#var/player_age">player_age</a></th><td>Used to determine how old the account is - in days.</td></tr>
<tr><th><a href="client.html#var/player_details">player_details</a></th><td>these persist between logins/logouts during the same round.</td></tr>
<tr><th><a href="client.html#var/player_join_date">player_join_date</a></th><td>Date that this account was first seen in the server</td></tr>
<tr><th><a href="client.html#var/prefs">prefs</a></th><td>Player preferences datum for the client</td></tr>
<tr><th><a href="client.html#var/related_accounts_cid">related_accounts_cid</a></th><td>So admins know why it isn't working - Used to determine what other accounts previously logged in from this computer id</td></tr>
<tr><th><a href="client.html#var/related_accounts_ip">related_accounts_ip</a></th><td>So admins know why it isn't working - Used to determine what other accounts previously logged in from this ip</td></tr>
<tr><th><a href="client.html#var/screen_maps">screen_maps</a></th><td>Assoc list with all the active maps - when a screen obj is added to
a map, it's put in here as well.</td></tr>
<tr><th><a href="client.html#var/seen_messages">seen_messages</a></th><td>Messages currently seen by this client</td></tr>
<tr><th><a href="client.html#var/selected_target">selected_target</a></th><td>Autoclick list of two elements, first being the clicked thing, second being the parameters.</td></tr>
<tr><th><a href="client.html#var/tooltips">tooltips</a></th><td>datum that controls the displaying and hiding of tooltips</td></tr>
<tr><th><a href="client.html#var/topiclimiter">topiclimiter</a></th><td>Used for limiting the rate of topic sends by the client to avoid abuse</td></tr>
<tr><th><a href="client.html#var/total_count_reset">total_count_reset</a></th><td>Next tick to reset the total message counter</td></tr>
<tr><th><a href="client.html#var/total_message_count">total_message_count</a></th><td>How many messages sent in the last 10 seconds</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr>
<tr><th><a href="client.html#proc/Move">Move</a></th><td>Move a client in a direction</td></tr>
<tr><th><a href="client.html#proc/Move_object">Move_object</a></th><td>force move the control_object of your client mob</td></tr>
<tr><th><a href="client.html#proc/Process_Grab">Process_Grab</a></th><td>Checks to see if you're being grabbed and if so attempts to break it</td></tr>
<tr><th><a href="client.html#proc/Process_Incorpmove">Process_Incorpmove</a></th><td>Allows mobs to ignore density and phase through objects</td></tr>
<tr><th><a href="client.html#proc/ResetAmbiencePlayed">ResetAmbiencePlayed</a></th><td>Reset the played var to false on the client</td></tr>
<tr><th><a href="client.html#proc/asset_cache_confirm_arrival">asset_cache_confirm_arrival</a></th><td>Process asset cache client topic calls for &quot;asset_cache_confirm_arrival=[INT]&quot;</td></tr>
<tr><th><a href="client.html#proc/asset_cache_preload_data">asset_cache_preload_data</a></th><td>Process asset cache client topic calls for &quot;asset_cache_preload_data=[HTML+JSON_STRING]</td></tr>
<tr><th><a href="client.html#proc/asset_cache_update_json">asset_cache_update_json</a></th><td>Updates the client side stored html/json combo file used to keep track of what assets the client has between restarts/reconnects.</td></tr>
<tr><th><a href="client.html#proc/asset_flush">asset_flush</a></th><td>Blocks until all currently sending browser 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.</td></tr>
<tr><th><a href="client.html#proc/award_heart">award_heart</a></th><td>Redirect proc that makes it easier to get the status of an achievement. Achievement type is the typepath to the award.</td></tr>
<tr><th><a href="client.html#proc/body_chest">body_chest</a></th><td>Hidden verb to target the chest, bound to 5</td></tr>
<tr><th><a href="client.html#proc/body_groin">body_groin</a></th><td>Hidden verb to target the groin, bound to 2</td></tr>
<tr><th><a href="client.html#proc/body_l_arm">body_l_arm</a></th><td>Hidden verb to target the left arm, bound to 6</td></tr>
<tr><th><a href="client.html#proc/body_l_leg">body_l_leg</a></th><td>Hidden verb to target the left leg, bound to 3</td></tr>
<tr><th><a href="client.html#proc/body_r_arm">body_r_arm</a></th><td>Hidden verb to target the right arm, bound to 4</td></tr>
<tr><th><a href="client.html#proc/body_r_leg">body_r_leg</a></th><td>Hidden verb to target the right leg, bound to 1</td></tr>
<tr><th><a href="client.html#proc/body_toggle_head">body_toggle_head</a></th><td>Hidden verb to set the target zone of a mob to the head</td></tr>
<tr><th><a href="client.html#proc/check_has_body_select">check_has_body_select</a></th><td>Validate the client's mob has a valid zone selected</td></tr>
<tr><th><a href="client.html#proc/clear_all_maps">clear_all_maps</a></th><td>Clears all the maps of registered screen objects.</td></tr>
<tr><th><a href="client.html#proc/clear_map">clear_map</a></th><td>Clears the map of registered screen objects.</td></tr>
<tr><th><a href="client.html#proc/close_popup">close_popup</a></th><td>Closes a popup.</td></tr>
<tr><th><a href="client.html#proc/create_popup">create_popup</a></th><td>Creates a popup window with a basic map element in it, without any
further initialization.</td></tr>
<tr><th><a href="client.html#proc/drop_item">drop_item</a></th><td>If your mob is concious, drop the item in the active hand</td></tr>
<tr><th><a href="client.html#proc/get_award_status">get_award_status</a></th><td>Redirect proc that makes it easier to get the status of an achievement. Achievement type is the typepath to the award.</td></tr>
<tr><th><a href="client.html#proc/give_award">give_award</a></th><td>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</td></tr>
<tr><th><a href="client.html#proc/handle_popup_close">handle_popup_close</a></th><td>When the popup closes in any way (player or proc call) it calls this.</td></tr>
<tr><th><a href="client.html#proc/keyUp">keyUp</a></th><td>Check if the key is short enough to even be a real key</td></tr>
<tr><th><a href="client.html#proc/register_map_obj">register_map_obj</a></th><td>Registers screen obj with the client, which makes it visible on the
assigned map, and becomes a part of the assigned map's lifecycle.</td></tr>
<tr><th><a href="client.html#proc/setup_popup">setup_popup</a></th><td>Create the popup, and get it ready for generic use by giving
it a background.</td></tr>
<tr><th><a href="client.html#proc/toggle_walk_run">toggle_walk_run</a></th><td>Verb to toggle the walk or run status</td></tr>
<tr><th><a href="client.html#proc/uiclose">uiclose</a></th><td>verb</td></tr></table>
<h2 id="var">Var Details</h2><h3 id="var/AI_Interact"><aside class="declaration">var </aside>AI_Interact
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L15">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 15"/></a></h3>
<p>Used for admin AI interaction</p><h3 id="var/account_age"><aside class="declaration">var </aside>account_age
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L69">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 69"/></a></h3>
<p>Age of byond account in days</p><h3 id="var/account_join_date"><aside class="declaration">var </aside>account_join_date
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L67">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 67"/></a></h3>
<p>Date of byond account creation in ISO 8601 format</p><h3 id="var/active_mousedown_item"><aside class="declaration">var </aside>active_mousedown_item
<aside>&ndash; /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a></aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L130">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 130"/></a></h3>
<p>Autoclick variable referencing the associated item.</p><h3 id="var/ambience_playing"><aside class="declaration">var </aside>ambience_playing
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L46">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 46"/></a></h3>
<p>Currently playing ambience sound</p><h3 id="var/area"><aside class="declaration">var </aside>area
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L40">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 40"/></a></h3>
<p>Current area of the controlled mob</p><h3 id="var/avgping"><aside class="declaration">var </aside>avgping
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L89">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 89"/></a></h3>
<p>Average ping of the client</p><h3 id="var/ban_cache"><aside class="declaration">var </aside>ban_cache
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L18">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 18"/></a></h3>
<p>Used to cache this client's bans to save on DB queries</p><h3 id="var/char_render_holders"><aside class="declaration">var </aside>char_render_holders
<aside>&ndash; /list</aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L114">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 114"/></a></h3>
<p>Should only be a key-value list of north/south/east/west = obj/screen.</p><h3 id="var/chatOutput"><aside class="declaration">var </aside>chatOutput
<aside>&ndash; /<a href="datum.html">datum</a>/chatOutput</aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L105">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 105"/></a></h3>
<p>goonchat chatoutput of the client</p><h3 id="var/click_intercept"><aside class="declaration">var </aside>click_intercept
<aside>&ndash; /<a href="datum.html">datum</a></aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L13">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 13"/></a></h3>
<p>Needs to implement InterceptClickOn(user,params,atom) proc</p><h3 id="var/clicklimiter"><aside class="declaration">var </aside>clicklimiter
<aside>&ndash; /list</aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L102">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 102"/></a></h3>
<p>Used for limiting the rate of clicks sends by the client to avoid abuse</p><h3 id="var/client_keysend_amount"><aside class="declaration">var </aside>client_keysend_amount
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L117">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 117"/></a></h3>
<p>Amount of keydowns in the last keysend checking interval</p><h3 id="var/connection_realtime"><aside class="declaration">var </aside>connection_realtime
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L93">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 93"/></a></h3>
<p>world.realtime they connected</p><h3 id="var/connection_time"><aside class="declaration">var </aside>connection_time
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L91">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 91"/></a></h3>
<p>world.time they connected</p><h3 id="var/connection_timeofday"><aside class="declaration">var </aside>connection_timeofday
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L95">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 95"/></a></h3>
<p>world.timeofday they connected</p><h3 id="var/credits"><aside class="declaration">var </aside>credits
<aside>&ndash; /list</aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L108">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 108"/></a></h3>
<p>lazy list of all credit object bound to this client</p><h3 id="var/current_key_address"><aside class="declaration">var </aside>current_key_address
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/keybindings/setup.dm#L5">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;keybindings&#x2F;setup.dm 5"/></a></h3>
<p>used to keep track of the current rolling buffer position</p><h3 id="var/externalreplyamount"><aside class="declaration">var </aside>externalreplyamount
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L28">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 28"/></a></h3>
<p>Internal counter for clients sending external (IRC/Discord) relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.</p><h3 id="var/holder"><aside class="declaration">var </aside>holder
<aside>&ndash; /<a href="datum.html">datum</a>/<a href="datum/admins.html">admins</a></aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L11">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 11"/></a></h3>
<p>Contains admin info. Null if client is not an admin.</p><h3 id="var/inprefs"><aside class="declaration">var </aside>inprefs
<aside>&ndash; </aside>
<a href="https://github.com/tgstation/tgstation/blob/3d3d7fcc2cc32d945b8427cb7e4524883dee7fa3/code/modules/client/client_defines.dm#L98">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;client&#x2F;client_defines.dm 98"/></a></h3>
<p>If the client is currently in player preferences</p><h3 id="var/ip_intel"><aside class="declaration">var </aside>ip_intel