deploy: 143ec750cf

2026-07-27 16:52:34 -07:00 · 2023-10-16 03:36:10 +00:00
parent c5c867a817
commit cbb3e121f4
17 changed files with 39 additions and 39 deletions
@@ -2,7 +2,7 @@
 </code></pre></div></div> <ul> <li>Returns FID information about the square under the given tile at elevation 0</li> <li>Pass elevation as 4-bit number in bits 25-28 to access other elevations</li> <li>Pass result mode in bits 29-32: 0 - ground FID, 1 - roof FID, 2 - raw data.</li> </ul><hr /> <h3 class="d-inline-block" id="get_tile_ground_fid"> <a href="#get_tile_ground_fid" class="anchor-heading" aria-labelledby="get_tile_ground_fid"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>get_tile_ground_fid</strong> </h3> <p class="label label-green">sfall.h</p> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">get_tile_ground_fid</span><span class="p">(</span><span class="kt">int</span> <span class="n">tileNum</span><span class="p">,</span> <span class="kt">int</span> <span class="n">elevation</span><span class="p">)</span>
 </code></pre></div></div> <p>Returns FID of a ground tile at given tile number and elevation.</p><hr /> <h3 class="d-inline-block" id="get_tile_roof_fid"> <a href="#get_tile_roof_fid" class="anchor-heading" aria-labelledby="get_tile_roof_fid"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>get_tile_roof_fid</strong> </h3> <p class="label label-green">sfall.h</p> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">get_tile_roof_fid</span><span class="p">(</span><span class="kt">int</span> <span class="n">tileNum</span><span class="p">,</span> <span class="kt">int</span> <span class="n">elevation</span><span class="p">)</span>
 </code></pre></div></div> <p>Returns FID of a roof tile at given tile number and elevation. Note that FID of 1 is used when there is no actual roof.</p><hr /> <h3 id="obj_blocking_line"> <a href="#obj_blocking_line" class="anchor-heading" aria-labelledby="obj_blocking_line"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>obj_blocking_line</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">ObjectPtr</span> <span class="n">obj_blocking_line</span><span class="p">(</span><span class="n">ObjectPtr</span> <span class="n">objFrom</span><span class="p">,</span> <span class="kt">int</span> <span class="n">tileTo</span><span class="p">,</span> <span class="kt">int</span> <span class="n">blockingType</span><span class="p">)</span>
-</code></pre></div></div> <p>Returns first object which blocks direct linear path from <code class="language-plaintext highlighter-rouge">objFrom</code> to <code class="language-plaintext highlighter-rouge">tileTo</code> using selected blocking function (see <code class="language-plaintext highlighter-rouge">BLOCKING_TYPE_*</code> constants in <code class="language-plaintext highlighter-rouge">sfall.h</code>). If path is clear (no blocker was encountered by selected function) - returns 0. <code class="language-plaintext highlighter-rouge">objFrom</code> is always excluded from calculations, but is required to be a valid object.</p><hr /> <h3 id="obj_blocking_tile"> <a href="#obj_blocking_tile" class="anchor-heading" aria-labelledby="obj_blocking_tile"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>obj_blocking_tile</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">ObjectPtr</span> <span class="n">obj_blocking_tile</span><span class="p">(</span><span class="kt">int</span> <span class="n">tileNum</span><span class="p">,</span> <span class="kt">int</span> <span class="n">elevation</span><span class="p">,</span> <span class="kt">int</span> <span class="n">blockingType</span><span class="p">)</span>
+</code></pre></div></div> <p>Returns first object which blocks direct linear path from <code class="language-plaintext highlighter-rouge">objFrom</code> to <code class="language-plaintext highlighter-rouge">tileTo</code> using selected blocking function (see <code class="language-plaintext highlighter-rouge">BLOCKING_TYPE_*</code> constants in <strong>sfall.h</strong>). If path is clear (no blocker was encountered by selected function) - returns 0. <code class="language-plaintext highlighter-rouge">objFrom</code> is always excluded from calculations, but is required to be a valid object.</p><hr /> <h3 id="obj_blocking_tile"> <a href="#obj_blocking_tile" class="anchor-heading" aria-labelledby="obj_blocking_tile"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>obj_blocking_tile</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">ObjectPtr</span> <span class="n">obj_blocking_tile</span><span class="p">(</span><span class="kt">int</span> <span class="n">tileNum</span><span class="p">,</span> <span class="kt">int</span> <span class="n">elevation</span><span class="p">,</span> <span class="kt">int</span> <span class="n">blockingType</span><span class="p">)</span>
 </code></pre></div></div> <p>Returns first object blocking given tile using given blocking function or 0 if tile is clear.</p><hr /> <h3 id="path_find_to"> <a href="#path_find_to" class="anchor-heading" aria-labelledby="path_find_to"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>path_find_to</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">array</span> <span class="n">path_find_to</span><span class="p">(</span><span class="n">ObjectPtr</span> <span class="n">objFrom</span><span class="p">,</span> <span class="kt">int</span> <span class="n">tileTo</span><span class="p">,</span> <span class="kt">int</span> <span class="n">blockingType</span><span class="p">)</span>
 </code></pre></div></div> <p>Returns the shortest path to a given tile using given blocking function as an array of tile directions (0..5) to move on each step. Array length equals to a number of steps. Empty array means that specified target cannot be reached.</p><hr /> <h3 class="d-inline-block" id="tile_by_position"> <a href="#tile_by_position" class="anchor-heading" aria-labelledby="tile_by_position"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>tile_by_position</strong> </h3> <p class="label label-green">sfall.h</p> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">tile_by_position</span><span class="p">(</span><span class="kt">int</span> <span class="n">x</span><span class="p">,</span> <span class="kt">int</span> <span class="n">y</span><span class="p">)</span>
 </code></pre></div></div> <ul> <li>returns the tile number at the x, y position relative to the top-left corner of the screen</li> <li>if the position is outside of the range of tiles, it will return -1</li> </ul><hr /> <h3 id="tile_get_objs"> <a href="#tile_get_objs" class="anchor-heading" aria-labelledby="tile_get_objs"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>tile_get_objs</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">array</span> <span class="n">tile_get_objs</span><span class="p">(</span><span class="kt">int</span> <span class="n">tileNum</span><span class="p">,</span> <span class="kt">int</span> <span class="n">elevation</span><span class="p">)</span>