Files
GS13NG/datum/controller/subsystem/mapping.html
T
2025-02-05 06:19:18 +00:00

3 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/controller/subsystem/mapping - /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><a href="datum/controller/subsystem/mapping.html#var">Var Details</a> - <a href="datum/controller/subsystem/mapping.html#proc">Proc Details</a></header><main><h1>mapping <aside>/<a href="datum.html">datum</a>/<a href="datum/controller/subsystem.html">controller/subsystem</a>/<a href="datum/controller/subsystem/mapping.html">mapping</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L3"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 3"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#var/biomes">biomes</a></th><td>All possible biomes in assoc list as type || instance</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#var/obfuscation_next_id">obfuscation_next_id</a></th><td>next id for separating obfuscated ids.</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#var/obfuscation_secret">obfuscation_secret</a></th><td>&quot;secret&quot; key</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#var/random_generated_ids_by_original">random_generated_ids_by_original</a></th><td>Lookup list for random generated IDs.</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#var/z_to_station_z_index">z_to_station_z_index</a></th><td>Lookup for zlevel to station z. text = num.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/get_obfuscated_id">get_obfuscated_id</a></th><td>Generates an obfuscated but constant id for an original id for cases where you don't want players codediving for an id.
WARNING: MAKE SURE PLAYERS ARE NOT ABLE TO ACCESS THIS. To save performance, it's just secret + an incrementing number. Very guessable if you know what the secret is.</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/get_station_center">get_station_center</a></th><td>Prefer not to use this one too often</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/get_turf_above">get_turf_above</a></th><td>Attempt to get the turf above the provided one according to Z traits</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/get_turf_below">get_turf_below</a></th><td>Attempt to get the turf below the provided one according to Z traits</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/initialize_biomes">initialize_biomes</a></th><td>Initialize all biomes, assoc as type || instance</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/level_has_all_traits">level_has_all_traits</a></th><td>Check if levels[z] has all of the specified traits</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/level_has_any_trait">level_has_any_trait</a></th><td>Check if levels[z] has any of the specified traits</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/level_trait">level_trait</a></th><td>Look up levels[z].traits[trait]</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/levels_by_any_trait">levels_by_any_trait</a></th><td>Get a list of all z which have any of the specified traits</td></tr><tr><th><a href="datum/controller/subsystem/mapping.html#proc/levels_by_trait">levels_by_trait</a></th><td>Get a list of all z which have the specified trait</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/biomes"><aside class="declaration">var </aside>biomes <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L38"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 38"></a></h3><p>All possible biomes in assoc list as type || instance</p><h3 id="var/obfuscation_next_id"><aside class="declaration">var </aside>obfuscation_next_id <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L55"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 55"></a></h3><p>next id for separating obfuscated ids.</p><h3 id="var/obfuscation_secret"><aside class="declaration">var </aside>obfuscation_secret <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L60"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 60"></a></h3><p>&quot;secret&quot; key</p><h3 id="var/random_generated_ids_by_original"><aside class="declaration">var </aside>random_generated_ids_by_original <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L53"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 53"></a></h3><p>Lookup list for random generated IDs.</p><h3 id="var/z_to_station_z_index"><aside class="declaration">var </aside>z_to_station_z_index <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L48"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 48"></a></h3><p>Lookup for zlevel to station z. text = num.</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_obfuscated_id"><aside class="declaration">proc </aside>get_obfuscated_id<aside>(original, id_type) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L637"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 637"></a></aside></h3><p>Generates an obfuscated but constant id for an original id for cases where you don't want players codediving for an id.
WARNING: MAKE SURE PLAYERS ARE NOT ABLE TO ACCESS THIS. To save performance, it's just secret + an incrementing number. Very guessable if you know what the secret is.</p><h3 id="proc/get_station_center"><aside class="declaration">proc </aside>get_station_center<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L71"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 71"></a></aside></h3><p>Prefer not to use this one too often</p><h3 id="proc/get_turf_above"><aside class="declaration">proc </aside>get_turf_above<aside>(/<a href="turf.html">turf</a>/T) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 62"></a></aside></h3><p>Attempt to get the turf above the provided one according to Z traits</p><h3 id="proc/get_turf_below"><aside class="declaration">proc </aside>get_turf_below<aside>(/<a href="turf.html">turf</a>/T) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L53"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 53"></a></aside></h3><p>Attempt to get the turf below the provided one according to Z traits</p><h3 id="proc/initialize_biomes"><aside class="declaration">proc </aside>initialize_biomes<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/subsystem/mapping.dm#L606"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/mapping.dm 606"></a></aside></h3><p>Initialize all biomes, assoc as type || instance</p><h3 id="proc/level_has_all_traits"><aside class="declaration">proc </aside>level_has_all_traits<aside>(z, /list/traits) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L26"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 26"></a></aside></h3><p>Check if levels[z] has all of the specified traits</p><h3 id="proc/level_has_any_trait"><aside class="declaration">proc </aside>level_has_any_trait<aside>(z, /list/traits) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L19"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 19"></a></aside></h3><p>Check if levels[z] has any of the specified traits</p><h3 id="proc/level_trait"><aside class="declaration">proc </aside>level_trait<aside>(z, trait) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L2"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 2"></a></aside></h3><p>Look up levels[z].traits[trait]</p><h3 id="proc/levels_by_any_trait"><aside class="declaration">proc </aside>levels_by_any_trait<aside>(/list/traits) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L42"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 42"></a></aside></h3><p>Get a list of all z which have any of the specified traits</p><h3 id="proc/levels_by_trait"><aside class="declaration">proc </aside>levels_by_trait<aside>(trait) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/space_management/traits.dm#L33"><img src="git.png" width="16" height="16" title="code/modules/mapping/space_management/traits.dm 33"></a></aside></h3><p>Get a list of all z which have the specified trait</p></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>