sheepishgoat
7 lines
2.0 KiB
HTML
7 lines
2.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>code/__HELPERS/areas.dm - /tg/ Station 13</title></head><body><header><a href="index.html">/tg/ Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a></header><main><h1>code/__HELPERS/areas.dm <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__HELPERS/areas.dm0"><img src="git.png" width="16" height="16" title="code/__HELPERS/areas.dm0"></a></h1><table class="summary" cellspacing="0"><tr><th>/proc/<a href="global.html#proc/get_base_area">get_base_area</a></th><td>Returns the base area the target is located in if there is one.
|
|
Alternatively, returns the area as is.</td></tr><tr><th>/proc/<a href="global.html#proc/get_sub_areas">get_sub_areas</a></th><td>Returns either null, or a list containing every sub area associated with our base area.
|
|
If include_base is TRUE, the base area will also be added to the return list.</td></tr><tr><th>/proc/<a href="global.html#proc/get_sub_areas_turfs">get_sub_areas_turfs</a></th><td>Proc used for purposes similar to get_areas_turfs(), but aimed to include associated areas.
|
|
Only accepts area instances and paths for the first arg, no text strings.
|
|
Returns a list of all turfs found in the sub areas (including the base's if include_base is TRUE)
|
|
and located in a z level matching target_z, or anywhere if target_z is 0</td></tr><tr><th>/proc/<a href="global.html#proc/get_sub_areas_contents">get_sub_areas_contents</a></th><td>Simple proc that returns a sum of all contents from every sub area,
|
|
Think of the above but for all contents, not just turfs, and without target z.</td></tr></table></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e">e8e0068</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html> |