Skip to content

Commit

Permalink
Deploying to gh-pages from @ c7e20e4 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Nov 3, 2024
0 parents commit 6da2be1
Show file tree
Hide file tree
Showing 1,112 changed files with 71,780 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.cm-ss13.com
131 changes: 131 additions & 0 deletions area.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />

<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;area - byond</title>
</head>
<body>
<header>
<a href="index.html">byond</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>Unknown <aside>/<a href="area.html">area</a></aside><aside> inherits /<a href="atom.html">atom</a></aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L8">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 8"/></a></h1>

<table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr>
<tr><th><a href="area.html#var/ambience_exterior">ambience_exterior</a></th><td>Default sound to play as ambience for clients entering the area</td></tr>
<tr><th><a href="area.html#var/area_has_base_lighting">area_has_base_lighting</a></th><td>Whether this area has a currently active base lighting, bool</td></tr>
<tr><th><a href="area.html#var/base_lighting_alpha">base_lighting_alpha</a></th><td>alpha 0-255 of lighting_effect and thus baselighting intensity</td></tr>
<tr><th><a href="area.html#var/base_lighting_color">base_lighting_color</a></th><td>The colour of the light acting on this area</td></tr>
<tr><th><a href="area.html#var/block_game_interaction">block_game_interaction</a></th><td>If this area is outside the game's normal interactivity and should be excluded from things like EOR reports and crew monitors.
Doesn't need to be set for areas/Z levels that are marked as admin-only</td></tr>
<tr><th><a href="area.html#var/flags_area">flags_area</a></th><td>Bitfield of special area features</td></tr>
<tr><th><a href="area.html#var/lighting_effect">lighting_effect</a></th><td>The mutable appearance we underlay to show light</td></tr>
<tr><th><a href="area.html#var/linked_lz">linked_lz</a></th><td>Which, if any, LZ this area belongs to. If an area belongs to an LZ, if that LZ is designated as the primary
LZ, all weeds will be destroyed and further weed placement disabled</td></tr>
<tr><th><a href="area.html#var/sound_environment">sound_environment</a></th><td>Default sound environment to use for the area, as list or int BYOND preset: http://www.byond.com/docs/ref/#/sound/var/environment</td></tr>
<tr><th><a href="area.html#var/static_lighting">static_lighting</a></th><td>Whether this area allows static lighting and thus loads the lighting objects</td></tr>
<tr><th><a href="area.html#var/unoviable_timer">unoviable_timer</a></th><td>How long this area should be un-oviable</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr>
<tr><th><a href="area.html#proc/get_sound_ambience">get_sound_ambience</a></th><td>Returns the correct ambience sound track for a client in this area</td></tr>
<tr><th><a href="area.html#proc/handle_ovi_timer">handle_ovi_timer</a></th><td>From roundstart, sets a timer to make an area oviable.</td></tr>
<tr><th><a href="area.html#proc/purge_weeds">purge_weeds</a></th><td>Purges existing weeds, and prevents future weeds from being placed.</td></tr></table>
<h2 id="var">Var Details</h2><h3 id="var/ambience_exterior"><aside class="declaration">var </aside>ambience_exterior
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L60">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 60"/></a></h3>
<p>Default sound to play as ambience for clients entering the area</p><h3 id="var/area_has_base_lighting"><aside class="declaration">var </aside>area_has_base_lighting
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/modules/lighting/lighting_area.dm#L6">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;lighting&#x2F;lighting_area.dm 6"/></a></h3>
<p>Whether this area has a currently active base lighting, bool</p><h3 id="var/base_lighting_alpha"><aside class="declaration">var </aside>base_lighting_alpha
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/modules/lighting/lighting_area.dm#L8">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;lighting&#x2F;lighting_area.dm 8"/></a></h3>
<p>alpha 0-255 of lighting_effect and thus baselighting intensity</p><h3 id="var/base_lighting_color"><aside class="declaration">var </aside>base_lighting_color
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/modules/lighting/lighting_area.dm#L10">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;lighting&#x2F;lighting_area.dm 10"/></a></h3>
<p>The colour of the light acting on this area</p><h3 id="var/block_game_interaction"><aside class="declaration">var </aside>block_game_interaction
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L83">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 83"/></a></h3>
<p>If this area is outside the game's normal interactivity and should be excluded from things like EOR reports and crew monitors.
Doesn't need to be set for areas/Z levels that are marked as admin-only</p><h3 id="var/flags_area"><aside class="declaration">var </aside>flags_area
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L24">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 24"/></a></h3>
<p>Bitfield of special area features</p><h3 id="var/lighting_effect"><aside class="declaration">var </aside>lighting_effect
<aside>&ndash; /mutable_appearance</aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/modules/lighting/lighting_area.dm#L4">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;lighting&#x2F;lighting_area.dm 4"/></a></h3>
<p>The mutable appearance we underlay to show light</p><h3 id="var/linked_lz"><aside class="declaration">var </aside>linked_lz
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/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>Which, if any, LZ this area belongs to. If an area belongs to an LZ, if that LZ is designated as the primary
LZ, all weeds will be destroyed and further weed placement disabled</p><h3 id="var/sound_environment"><aside class="declaration">var </aside>sound_environment
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L62">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 62"/></a></h3>
<p>Default sound environment to use for the area, as list or int BYOND preset: http://www.byond.com/docs/ref/#/sound/var/environment</p><h3 id="var/static_lighting"><aside class="declaration">var </aside>static_lighting
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/modules/lighting/lighting_static/static_lighting_area.dm#L3">
<img src="git.png" width="16" height="16" title="code&#x2F;modules&#x2F;lighting&#x2F;lighting_static&#x2F;static_lighting_area.dm 3"/></a></h3>
<p>Whether this area allows static lighting and thus loads the lighting objects</p><h3 id="var/unoviable_timer"><aside class="declaration">var </aside>unoviable_timer
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L90">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 90"/></a></h3>
<p>How long this area should be un-oviable</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_sound_ambience"><aside class="declaration">proc </aside>get_sound_ambience<aside>(/<a href="client.html">client</a>/target)


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L132">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 132"/></a></aside>
</h3>
<p>Returns the correct ambience sound track for a client in this area</p><h3 id="proc/handle_ovi_timer"><aside class="declaration">proc </aside>handle_ovi_timer<aside>()


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L440">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 440"/></a></aside>
</h3>
<p>From roundstart, sets a timer to make an area oviable.</p><h3 id="proc/purge_weeds"><aside class="declaration">proc </aside>purge_weeds<aside>()


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/areas.dm#L434">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;areas.dm 434"/></a></aside>
</h3>
<p>Purges existing weeds, and prevents future weeds from being placed.</p></main>
<footer>
colonialmarines.dme
<a href="https://github.com/cmss13-devs/cmss13/tree/c7e20e49ff88063b91e0c568df188fcb7edb7dca">c7e20e4</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.8.0</a></footer>
</body>
</html>
50 changes: 50 additions & 0 deletions area/almayer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;area&#x2F;almayer - byond</title>
</head>
<body>
<header>
<a href="index.html">byond</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
&mdash; <a href="area/almayer.html#var">Var Details</a></header>
<main>
<h1>/<a href="area.html">area</a>/<a href="area/almayer.html">almayer</a>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/almayer.dm#L6">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;almayer.dm 6"/></a></h1>

<table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr>
<tr><th><a href="area/almayer.html#var/hijack_evacuation_area">hijack_evacuation_area</a></th><td>Whether this area is used for hijack evacuation progress</td></tr>
<tr><th><a href="area/almayer.html#var/hijack_evacuation_type">hijack_evacuation_type</a></th><td>Whether this area is additive or multiplicative towards evacuation progress</td></tr>
<tr><th><a href="area/almayer.html#var/hijack_evacuation_weight">hijack_evacuation_weight</a></th><td>The weight this area gives towards hijack evacuation progress</td></tr></table>
<h2 id="var">Var Details</h2><h3 id="var/hijack_evacuation_area"><aside class="declaration">var </aside>hijack_evacuation_area
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/almayer.dm#L19">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;almayer.dm 19"/></a></h3>
<p>Whether this area is used for hijack evacuation progress</p><h3 id="var/hijack_evacuation_type"><aside class="declaration">var </aside>hijack_evacuation_type
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/almayer.dm#L25">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;almayer.dm 25"/></a></h3>
<p>Whether this area is additive or multiplicative towards evacuation progress</p><h3 id="var/hijack_evacuation_weight"><aside class="declaration">var </aside>hijack_evacuation_weight
<aside>&ndash; </aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/almayer.dm#L22">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;almayer.dm 22"/></a></h3>
<p>The weight this area gives towards hijack evacuation progress</p></main>
<footer>
colonialmarines.dme
<a href="https://github.com/cmss13-devs/cmss13/tree/c7e20e49ff88063b91e0c568df188fcb7edb7dca">c7e20e4</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.8.0</a></footer>
</body>
</html>
35 changes: 35 additions & 0 deletions area/shuttle.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../" />
<link rel="stylesheet" href="dmdoc.css" />
<title>&#x2F;area&#x2F;shuttle - byond</title>
</head>
<body>
<header>
<a href="index.html">byond</a> -
<a href="index.html#modules">Modules</a> -
<a href="index.html#types">Types</a>
&mdash; <a href="area/shuttle.html#proc">Proc Details</a></header>
<main>
<h1>Shuttle <aside>/<a href="area.html">area</a>/<a href="area/shuttle.html">shuttle</a></aside>


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/shuttles.dm#L1">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;shuttles.dm 1"/></a></h1>

<table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Procs</h2></td></tr>
<tr><th><a href="area/shuttle.html#proc/PlaceOnTopReact">PlaceOnTopReact</a></th><td>area/shuttle/Initialize()</td></tr></table><h2 id="proc">Proc Details</h2><h3 id="proc/PlaceOnTopReact">PlaceOnTopReact<aside>(/list/new_baseturfs, /<a href="turf.html">turf</a>/fake_turf_type, flags)


<a href="https://github.com/cmss13-devs/cmss13/blob/c7e20e49ff88063b91e0c568df188fcb7edb7dca/code/game/area/shuttles.dm#L20">
<img src="git.png" width="16" height="16" title="code&#x2F;game&#x2F;area&#x2F;shuttles.dm 20"/></a></aside>
</h3>
<p>area/shuttle/Initialize()</p></main>
<footer>
colonialmarines.dme
<a href="https://github.com/cmss13-devs/cmss13/tree/c7e20e49ff88063b91e0c568df188fcb7edb7dca">c7e20e4</a>
(master) &mdash; <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.8.0</a></footer>
</body>
</html>
Loading

0 comments on commit 6da2be1

Please sign in to comment.