Files
GS13NG/datum/parsed_map.html
2025-02-05 06:19:18 +00:00

8 lines
4.7 KiB
HTML
Raw Permalink 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/parsed_map - /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/parsed_map.html#var">Var Details</a> - <a href="datum/parsed_map.html#proc">Proc Details</a></header><main><h1>parsed_map <aside>/<a href="datum.html">datum</a>/<a href="datum/parsed_map.html">parsed_map</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/reader.dm#L24"><img src="git.png" width="16" height="16" title="code/modules/mapping/reader.dm 24"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/parsed_map.html#var/bounds">bounds</a></th><td>Offset bounds. Same as parsed_bounds until load().</td></tr><tr><th><a href="datum/parsed_map.html#var/parsed_bounds">parsed_bounds</a></th><td>Unoffset bounds. Null on parse failure.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/parsed_map.html#proc/New">New</a></th><td>Parse a map, possibly cropping it.
Do not use the crop function unless strictly necessary.
WARNING: Crop function crops based on the tiles you'd see in the map editor. If you're planning to load it in in a different orientation later, you better have done the math.
It's recommended that you do not crop using this at all.</td></tr><tr><th><a href="datum/parsed_map.html#proc/check_for_errors">check_for_errors</a></th><td>Check a parsed but not yet loaded map for errors.</td></tr><tr><th><a href="datum/parsed_map.html#proc/load">load</a></th><td>Load the parsed map into the world. See <a href="global.html#proc/load_map" title="/global">/proc/load_map</a> for arguments.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/bounds"><aside class="declaration">var </aside>bounds <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/reader.dm#L37"><img src="git.png" width="16" height="16" title="code/modules/mapping/reader.dm 37"></a></h3><p>Offset bounds. Same as parsed_bounds until load().</p><h3 id="var/parsed_bounds"><aside class="declaration">var </aside>parsed_bounds <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/reader.dm#L33"><img src="git.png" width="16" height="16" title="code/modules/mapping/reader.dm 33"></a></h3><p>Unoffset bounds. Null on parse failure.</p><h2 id="proc">Proc Details</h2><h3 id="proc/New">New<aside>(tfile, x_lower, x_upper, y_lower, y_upper, z_lower, z_upper, measureOnly) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/reader.dm#L88"><img src="git.png" width="16" height="16" title="code/modules/mapping/reader.dm 88"></a></aside></h3><p>Parse a map, possibly cropping it.
Do not use the crop function unless strictly necessary.
WARNING: Crop function crops based on the tiles you'd see in the map editor. If you're planning to load it in in a different orientation later, you better have done the math.
It's recommended that you do not crop using this at all.</p><h3 id="proc/check_for_errors"><aside class="declaration">proc </aside>check_for_errors<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/verify.dm#L56"><img src="git.png" width="16" height="16" title="code/modules/mapping/verify.dm 56"></a></aside></h3><p>Check a parsed but not yet loaded map for errors.</p>
<p>Returns a <a href="datum/map_report.html" title="/datum/map_report">/datum/map_report</a> if there are errors or <code>FALSE</code> otherwise.</p><h3 id="proc/load"><aside class="declaration">proc </aside>load<aside>(x_offset, y_offset, z_offset, cropMap, no_changeturf, x_lower, x_upper, y_lower, y_upper, placeOnTop, orientation, annihilate_tiles, /<a href="datum.html">datum</a>/map_orientation_pattern/forced_pattern) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/reader.dm#L203"><img src="git.png" width="16" height="16" title="code/modules/mapping/reader.dm 203"></a></aside></h3><p>Load the parsed map into the world. See <a href="global.html#proc/load_map" title="/global">/proc/load_map</a> for arguments.</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>