deploy: fb47779d4c

animations/index.html

@@ -5,6 +5,6 @@
 </code></pre></div></div> <p>Should work like <code class="language-plaintext highlighter-rouge">art_change_fid_num</code> but in <code class="language-plaintext highlighter-rouge">reg_anim</code> sequence.</p><hr /> <h3 id="reg_anim_combat_check"> <a href="#reg_anim_combat_check" class="anchor-heading" aria-labelledby="reg_anim_combat_check"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_combat_check</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">reg_anim_combat_check</span><span class="p">(</span><span class="kt">int</span> <span class="n">enable</span><span class="p">)</span>
 </code></pre></div></div> <p>Allows enabling all <code class="language-plaintext highlighter-rouge">reg_anim_*</code> functions in combat (including vanilla functions) if set to 0. It is automatically reset at the end of each frame, so you need to call it before <code class="language-plaintext highlighter-rouge">reg_anim_begin</code> - <code class="language-plaintext highlighter-rouge">reg_anim_end</code> block.</p><hr /> <h3 id="reg_anim_destroy"> <a href="#reg_anim_destroy" class="anchor-heading" aria-labelledby="reg_anim_destroy"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_destroy</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">reg_anim_destroy</span><span class="p">(</span><span class="n">ObjectPtr</span><span class="p">)</span>
 </code></pre></div></div> <p>Given object is destroyed at the end of current animation set.</p><hr /> <h3 id="reg_anim_light"> <a href="#reg_anim_light" class="anchor-heading" aria-labelledby="reg_anim_light"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_light</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">reg_anim_light</span><span class="p">(</span><span class="n">ObjectPtr</span><span class="p">,</span> <span class="kt">int</span> <span class="n">light</span><span class="p">,</span> <span class="kt">int</span> <span class="n">delay</span><span class="p">)</span>
-</code></pre></div></div> <p>Change light of any object. Light argument is a light radius (0-8), but you can use highest 2 bytes to pass light intensity as well (example: 0xFFFF0008 - intensity 65535 and radius 8). If highest 2 bytes are 0, intensity will not be changed. Intensity range is from 0 to 65535 (0xFFFF)</p><hr /> <h3 id="reg_anim_take_out"> <a href="#reg_anim_take_out" class="anchor-heading" aria-labelledby="reg_anim_take_out"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_take_out</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">reg_anim_take_out</span><span class="p">(</span><span class="n">ObjectPtr</span><span class="p">,</span> <span class="n">holdFrameID</span><span class="p">,</span> <span class="n">delay</span><span class="p">)</span>
+</code></pre></div></div> <p>Change light of any object. Light argument is a light radius (0-8), but you can use highest 2 bytes to pass light intensity as well (example: 0xFFFF0008 - intensity 65535 and radius 8). If highest 2 bytes are 0, intensity will not be changed. Intensity range is from 0 to 65535 (0xFFFF)</p><hr /> <h3 id="reg_anim_take_out"> <a href="#reg_anim_take_out" class="anchor-heading" aria-labelledby="reg_anim_take_out"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_take_out</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">reg_anim_take_out</span><span class="p">(</span><span class="n">ObjectPtr</span><span class="p">,</span> <span class="kt">int</span> <span class="n">weaponCode</span><span class="p">,</span> <span class="kt">int</span> <span class="n">delay</span><span class="p">)</span>
-</code></pre></div></div> <p>Plays “take out weapon” animation for given <code class="language-plaintext highlighter-rouge">holdFrameID</code>. It is not required to have such weapon in critter’s inventory.</p><hr /> <h3 id="reg_anim_turn_towards"> <a href="#reg_anim_turn_towards" class="anchor-heading" aria-labelledby="reg_anim_turn_towards"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_turn_towards</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">reg_anim_turn_towards</span><span class="p">(</span><span class="n">ObjectPtr</span><span class="p">,</span> <span class="kt">int</span> <span class="n">tile</span><span class="o">/</span><span class="n">target</span><span class="p">,</span> <span class="n">delay</span><span class="p">)</span>
+</code></pre></div></div> <p>Plays “take out weapon” animation for the given <code class="language-plaintext highlighter-rouge">weaponCode</code> (see <code class="language-plaintext highlighter-rouge">WPN_ANIM_*</code> constants in <strong>define_extra.h</strong>).</p> <ul> <li>It is not required for the critter to have this type of weapon in its inventory.</li> </ul><hr /> <h3 id="reg_anim_turn_towards"> <a href="#reg_anim_turn_towards" class="anchor-heading" aria-labelledby="reg_anim_turn_towards"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_turn_towards</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">reg_anim_turn_towards</span><span class="p">(</span><span class="n">ObjectPtr</span><span class="p">,</span> <span class="kt">int</span> <span class="n">tile</span><span class="o">/</span><span class="n">target</span><span class="p">,</span> <span class="n">delay</span><span class="p">)</span>
-</code></pre></div></div> <p>Makes object change its direction to face given tile number or target object.</p> </main> <hr> <footer> <div class="d-md-none mt-4 fs-2"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
+</code></pre></div></div> <p>Makes object change its direction to face the given tile number or target object.</p> </main> <hr> <footer> <div class="d-md-none mt-4 fs-2"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>

feed.xml

@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.2">Jekyll</generator><link href="/sfall/feed.xml" rel="self" type="application/atom+xml" /><link href="/sfall/" rel="alternate" type="text/html" /><updated>2026-04-21T13:28:07+00:00</updated><id>/sfall/feed.xml</id><title type="html">sfall</title><subtitle>Sfall documentation</subtitle></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.2">Jekyll</generator><link href="/sfall/feed.xml" rel="self" type="application/atom+xml" /><link href="/sfall/" rel="alternate" type="text/html" /><updated>2026-04-23T14:38:17+00:00</updated><id>/sfall/feed.xml</id><title type="html">sfall</title><subtitle>Sfall documentation</subtitle></feed>

other/index.html

@@ -2,7 +2,7 @@
 </code></pre></div></div><hr /> <h3 class="d-inline-block" id="add_g_timer_event"> <a href="#add_g_timer_event" class="anchor-heading" aria-labelledby="add_g_timer_event"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>add_g_timer_event</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">void</span> <span class="n">add_g_timer_event</span><span class="p">(</span><span class="kt">int</span> <span class="n">time</span><span class="p">,</span> <span class="kt">int</span> <span class="n">fixedParam</span><span class="p">)</span>
 </code></pre></div></div> <p>Adds a timer event that calls the <code class="language-plaintext highlighter-rouge">timed_event_p_proc</code> procedure in the current global script <code class="language-plaintext highlighter-rouge">time</code>: the number of ticks after which the event timer is triggered <code class="language-plaintext highlighter-rouge">fixedParam</code>: the value that is passed to the <code class="language-plaintext highlighter-rouge">timed_event_p_proc</code> procedure for the <code class="language-plaintext highlighter-rouge">fixed_param</code> function</p><hr /> <h3 id="create_message_window"> <a href="#create_message_window" class="anchor-heading" aria-labelledby="create_message_window"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>create_message_window</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">create_message_window</span><span class="p">(</span><span class="n">string</span> <span class="n">message</span><span class="p">)</span>
 </code></pre></div></div><hr /> <h3 id="create_spatial"> <a href="#create_spatial" class="anchor-heading" aria-labelledby="create_spatial"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>create_spatial</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">ObjectPtr</span> <span class="n">create_spatial</span><span class="p">(</span><span class="kt">int</span> <span class="n">scriptID</span><span class="p">,</span> <span class="kt">int</span> <span class="n">tile</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">radius</span><span class="p">)</span>
-</code></pre></div></div> <p>Creates new spatial script with given SID, at given tile, and radius.</p><hr /> <h3 id="game_loaded"> <a href="#game_loaded" class="anchor-heading" aria-labelledby="game_loaded"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>game_loaded</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">game_loaded</span>
+</code></pre></div></div> <p>Creates new spatial script with the given scriptID at the given tile and radius.</p><hr /> <h3 id="game_loaded"> <a href="#game_loaded" class="anchor-heading" aria-labelledby="game_loaded"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>game_loaded</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">game_loaded</span>
 </code></pre></div></div> <p>Returns 1 the first time it is called after a new game or game load, and 0 any time after. It works on an individual basis for each script, so one script wont interfere with others. Its primary use is for global scripts, so that they know when to call <code class="language-plaintext highlighter-rouge">set_global_script_repeat</code>, but it can be called from normal scripts too.</p><hr /> <h3 id="gdialog_get_barter_mod"> <a href="#gdialog_get_barter_mod" class="anchor-heading" aria-labelledby="gdialog_get_barter_mod"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>gdialog_get_barter_mod</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">gdialog_get_barter_mod</span>
 </code></pre></div></div><hr /> <h3 id="get_game_mode"> <a href="#get_game_mode" class="anchor-heading" aria-labelledby="get_game_mode"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>get_game_mode</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">get_game_mode</span>
 </code></pre></div></div> <p>A more flexible version of in_world_map. It will return a set of flags indicating which mode the game is currently in. These flags are the same as those used in the <code class="language-plaintext highlighter-rouge">set_shader_mode function</code>.</p><hr /> <h3 id="get_inven_ap_cost"> <a href="#get_inven_ap_cost" class="anchor-heading" aria-labelledby="get_inven_ap_cost"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>get_inven_ap_cost</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">get_inven_ap_cost</span>

sfall-funcx-macros/index.html

@@ -21,5 +21,5 @@
 </code></pre></div></div> <p>Displays the specified hidden script window. <code class="language-plaintext highlighter-rouge">winName</code>: the window name, assigned to the window by the <code class="language-plaintext highlighter-rouge">CreateWin/create_win</code> function</p><hr /> <h3 class="d-inline-block" id="sfall_func2string_compare-string-str1-string-str2"> <a href="#sfall_func2string_compare-string-str1-string-str2" class="anchor-heading" aria-labelledby="sfall_func2string_compare-string-str1-string-str2"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func2(“string_compare”, string str1, string str2)</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">bool</span> <span class="n">sfall_func2</span><span class="p">(</span><span class="s">"string_compare"</span><span class="p">,</span> <span class="n">string</span> <span class="n">str1</span><span class="p">,</span> <span class="n">string</span> <span class="n">str2</span><span class="p">)</span>
 </code></pre></div></div> <p>Compares two strings case-insensitive, and returns <code class="language-plaintext highlighter-rouge">True</code> if the two strings are matched.</p><hr /> <h3 class="d-inline-block" id="sfall_func3string_compare-string-str1-string-str2-int-codepage"> <a href="#sfall_func3string_compare-string-str1-string-str2-int-codepage" class="anchor-heading" aria-labelledby="sfall_func3string_compare-string-str1-string-str2-int-codepage"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func3(“string_compare”, string str1, string str2, int codePage)</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">bool</span> <span class="n">sfall_func3</span><span class="p">(</span><span class="s">"string_compare"</span><span class="p">,</span> <span class="n">string</span> <span class="n">str1</span><span class="p">,</span> <span class="n">string</span> <span class="n">str2</span><span class="p">,</span> <span class="kt">int</span> <span class="n">codePage</span><span class="p">)</span>
 </code></pre></div></div> <p>Compares two strings case-insensitive, and returns <code class="language-plaintext highlighter-rouge">True</code> if the two strings are matched</p> <ul> <li><code class="language-plaintext highlighter-rouge">codePage</code>: code page number to properly compare national characters in the range 128-255 of the ASCII code table available encodings: 1250-1252, 866</li> </ul><hr /> <h3 class="d-inline-block" id="spatial_radius"> <a href="#spatial_radius" class="anchor-heading" aria-labelledby="spatial_radius"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>spatial_radius</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">spatial_radius</span><span class="p">(</span><span class="n">ObjectPtr</span> <span class="n">obj</span><span class="p">)</span>
-</code></pre></div></div> <p>Returns radius of spatial script, associated with given dummy-object (returned by <code class="language-plaintext highlighter-rouge">create_spatial</code>).</p><hr /> <h3 class="d-inline-block" id="void-sfall_func0remove_timer_event"> <a href="#void-sfall_func0remove_timer_event" class="anchor-heading" aria-labelledby="void-sfall_func0remove_timer_event"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>void sfall_func0(“remove_timer_event”)</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">void</span> <span class="n">sfall_func0</span><span class="p">(</span><span class="s">"remove_timer_event"</span><span class="p">)</span>
+</code></pre></div></div> <p>Returns radius of spatial script, associated with the given dummy object (returned by <code class="language-plaintext highlighter-rouge">create_spatial</code>).</p><hr /> <h3 class="d-inline-block" id="void-sfall_func0remove_timer_event"> <a href="#void-sfall_func0remove_timer_event" class="anchor-heading" aria-labelledby="void-sfall_func0remove_timer_event"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>void sfall_func0(“remove_timer_event”)</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">void</span> <span class="n">sfall_func0</span><span class="p">(</span><span class="s">"remove_timer_event"</span><span class="p">)</span>
 </code></pre></div></div> <p>Clears all set timer events for the current global script.</p> </main> <hr> <footer> <div class="d-md-none mt-4 fs-2"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>