This commit is contained in:
github-actions[bot]
2024-05-27 14:27:22 +00:00
parent d922640f9a
commit 74555dbac4
4 changed files with 6 additions and 6 deletions
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -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.0">Jekyll</generator><link href="/sfall/feed.xml" rel="self" type="application/atom+xml" /><link href="/sfall/" rel="alternate" type="text/html" /><updated>2024-05-27T13:36:24+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.0">Jekyll</generator><link href="/sfall/feed.xml" rel="self" type="application/atom+xml" /><link href="/sfall/" rel="alternate" type="text/html" /><updated>2024-05-27T14:27:16+00:00</updated><id>/sfall/feed.xml</id><title type="html">sfall</title><subtitle>Sfall documentation</subtitle></feed>
+1 -1
View File
@@ -66,7 +66,7 @@ int arg2 - attack type (see ATKTYPE_* constants)
int arg3 - original result of engine function: 1 - can use, 0 - cannot use int arg3 - original result of engine function: 1 - can use, 0 - cannot use
int ret0 - overrides the result of engine function. Any non-zero value allows using the weapon int ret0 - overrides the result of engine function. Any non-zero value allows using the weapon
</code></pre></div></div> <h2 id="cartravel"> <a href="#cartravel" class="anchor-heading" aria-labelledby="cartravel"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> CarTravel </h2> <p><code class="language-plaintext highlighter-rouge">HOOK_CARTRAVEL</code> (hs_cartravel.int)</p> <p>Runs continuously during worldmap travel on car.</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>int arg0 - vanilla car speed (between 3 and 8 "steps") </code></pre></div></div> <h2 id="cartravel"> <a href="#cartravel" class="anchor-heading" aria-labelledby="cartravel"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> CarTravel </h2> <p><code class="language-plaintext highlighter-rouge">HOOK_CARTRAVEL</code> (hs_cartravel.int)</p> <p>Runs continuously during world map travel by car.</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>int arg0 - vanilla car speed (between 3 and 8 "steps")
int arg1 - vanilla fuel consumption (100 and below) int arg1 - vanilla fuel consumption (100 and below)
int ret0 - car speed override (pass -1 if you just want to override fuel consumption) int ret0 - car speed override (pass -1 if you just want to override fuel consumption)
+2 -2
View File
@@ -11,9 +11,9 @@
</code></pre></div></div> <p>Enables/disables the engine function that increases the level of party members in the player leveling process. If the engine function is disabled, the process of leveling up party members should be performed by script functions.</p><hr /> <h3 class="d-inline-block" id="objects_in_radius"> <a href="#objects_in_radius" class="anchor-heading" aria-labelledby="objects_in_radius"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>objects_in_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="n">array</span> <span class="n">objects_in_radius</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">radius</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">type</span><span class="p">)</span> </code></pre></div></div> <p>Enables/disables the engine function that increases the level of party members in the player leveling process. If the engine function is disabled, the process of leveling up party members should be performed by script functions.</p><hr /> <h3 class="d-inline-block" id="objects_in_radius"> <a href="#objects_in_radius" class="anchor-heading" aria-labelledby="objects_in_radius"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>objects_in_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="n">array</span> <span class="n">objects_in_radius</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">radius</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">type</span><span class="p">)</span>
</code></pre></div></div> <ul> <li>returns an array of objects of a type (see <code class="language-plaintext highlighter-rouge">OBJ_TYPE_*</code> constants in <strong>define_extra.h</strong>) within the specified radius from the given tile</li> <li>passing -1 to the <code class="language-plaintext highlighter-rouge">type</code> argument or <em>not specifying it</em> will return all objects within the radius</li> <li>the radius is limited to 50 hexes</li> </ul><hr /> <h3 class="d-inline-block" id="set_drugs_data"> <a href="#set_drugs_data" class="anchor-heading" aria-labelledby="set_drugs_data"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_drugs_data</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">set_drugs_data</span><span class="p">(</span><span class="kt">int</span> <span class="n">type</span><span class="p">,</span> <span class="kt">int</span> <span class="n">pid</span><span class="p">,</span> <span class="kt">int</span> <span class="n">value</span><span class="p">)</span> </code></pre></div></div> <ul> <li>returns an array of objects of a type (see <code class="language-plaintext highlighter-rouge">OBJ_TYPE_*</code> constants in <strong>define_extra.h</strong>) within the specified radius from the given tile</li> <li>passing -1 to the <code class="language-plaintext highlighter-rouge">type</code> argument or <em>not specifying it</em> will return all objects within the radius</li> <li>the radius is limited to 50 hexes</li> </ul><hr /> <h3 class="d-inline-block" id="set_drugs_data"> <a href="#set_drugs_data" class="anchor-heading" aria-labelledby="set_drugs_data"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_drugs_data</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">set_drugs_data</span><span class="p">(</span><span class="kt">int</span> <span class="n">type</span><span class="p">,</span> <span class="kt">int</span> <span class="n">pid</span><span class="p">,</span> <span class="kt">int</span> <span class="n">value</span><span class="p">)</span>
</code></pre></div></div> <p>Overrides the parameters of drugs set in the configuration file (<code class="language-plaintext highlighter-rouge">DrugsFile</code> setting in <code class="language-plaintext highlighter-rouge">ddraw.ini</code>). Type: 0 - changes the value of <code class="language-plaintext highlighter-rouge">NumEffects</code> for the drug (see <code class="language-plaintext highlighter-rouge">Drugs.ini</code> for the description of <code class="language-plaintext highlighter-rouge">NumEffects</code>), 1 - changes the duration of the addiction effect for the drug (a value of 1 = one game minute).</p><hr /> <h3 class="d-inline-block" id="set_rest_heal_time"> <a href="#set_rest_heal_time" class="anchor-heading" aria-labelledby="set_rest_heal_time"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_rest_heal_time</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">set_rest_heal_time</span><span class="p">(</span><span class="kt">int</span> <span class="n">time</span><span class="p">)</span> </code></pre></div></div> <p>Overrides the parameters of drugs set in the configuration file (<code class="language-plaintext highlighter-rouge">DrugsFile</code> setting in <code class="language-plaintext highlighter-rouge">ddraw.ini</code>). Type: 0 - changes the value of <code class="language-plaintext highlighter-rouge">NumEffects</code> for the drug (see <code class="language-plaintext highlighter-rouge">Drugs.ini</code> for the description of <code class="language-plaintext highlighter-rouge">NumEffects</code>), 1 - changes the duration of the addiction effect for the drug (a value of 1 = one game minute).</p><hr /> <h3 class="d-inline-block" id="set_rest_heal_time"> <a href="#set_rest_heal_time" class="anchor-heading" aria-labelledby="set_rest_heal_time"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_rest_heal_time</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">set_rest_heal_time</span><span class="p">(</span><span class="kt">int</span> <span class="n">time</span><span class="p">)</span>
</code></pre></div></div> <p>Sets the time interval in minutes for healing during resting. The default is 180. Note: The interval will be reset each time the player reloads the game.</p><hr /> <h3 class="d-inline-block" id="set_rest_mode"> <a href="#set_rest_mode" class="anchor-heading" aria-labelledby="set_rest_mode"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_rest_mode</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">set_rest_mode</span><span class="p">(</span><span class="kt">int</span> <span class="n">flags</span><span class="p">)</span> </code></pre></div></div> <p>Sets the time interval in minutes for healing during resting. The default is 180</p> <ul> <li>the time interval will be reset each time the player reloads the game</li> </ul><hr /> <h3 class="d-inline-block" id="set_rest_mode"> <a href="#set_rest_mode" class="anchor-heading" aria-labelledby="set_rest_mode"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_rest_mode</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">set_rest_mode</span><span class="p">(</span><span class="kt">int</span> <span class="n">flags</span><span class="p">)</span>
</code></pre></div></div> <p>Sets the bit flags for the rest mode (see <code class="language-plaintext highlighter-rouge">RESTMODE_*</code> constants in <strong>sfall.h</strong>). Passing 0 will reset the rest mode. It will also be reset each time the player reloads the game.</p><hr /> <h3 class="d-inline-block" id="set_worldmap_heal_time"> <a href="#set_worldmap_heal_time" class="anchor-heading" aria-labelledby="set_worldmap_heal_time"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_worldmap_heal_time</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">set_worldmap_heal_time</span><span class="p">(</span><span class="kt">int</span> <span class="n">time</span><span class="p">)</span> </code></pre></div></div> <p>Sets the bit flags for the rest mode (see <code class="language-plaintext highlighter-rouge">RESTMODE_*</code> constants in <strong>sfall.h</strong>). Passing 0 will reset the rest mode. It will also be reset each time the player reloads the game.</p><hr /> <h3 class="d-inline-block" id="set_worldmap_heal_time"> <a href="#set_worldmap_heal_time" class="anchor-heading" aria-labelledby="set_worldmap_heal_time"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_worldmap_heal_time</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">set_worldmap_heal_time</span><span class="p">(</span><span class="kt">int</span> <span class="n">time</span><span class="p">)</span>
</code></pre></div></div> <p>Sets the time interval in minutes for healing during worldmap travel.</p> <ul> <li>passing 0 will revert to 1 second per real time (vanilla behavior)</li> <li>passing -1 will disable healing during travel</li> <li>the interval will be reset each time the player reloads the game</li> </ul><hr /> <h3 class="d-inline-block" id="sfall_func0hide_window"> <a href="#sfall_func0hide_window" class="anchor-heading" aria-labelledby="sfall_func0hide_window"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func0(“hide_window”)</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">"hide_window"</span><span class="p">)</span> </code></pre></div></div> <p>Sets the time interval in minutes for healing during world map travel</p> <ul> <li>passing 0 will revert to 1 second in real time (vanilla engine behavior)</li> <li>passing -1 will disable healing during travel</li> <li>the time interval will be reset each time the player reloads the game</li> </ul><hr /> <h3 class="d-inline-block" id="sfall_func0hide_window"> <a href="#sfall_func0hide_window" class="anchor-heading" aria-labelledby="sfall_func0hide_window"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func0(“hide_window”)</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">"hide_window"</span><span class="p">)</span>
</code></pre></div></div> <p>Hides currently active (selected) script window.</p><hr /> <h3 class="d-inline-block" id="sfall_func0show_window"> <a href="#sfall_func0show_window" class="anchor-heading" aria-labelledby="sfall_func0show_window"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func0(“show_window”)</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">"show_window"</span><span class="p">)</span> </code></pre></div></div> <p>Hides currently active (selected) script window.</p><hr /> <h3 class="d-inline-block" id="sfall_func0show_window"> <a href="#sfall_func0show_window" class="anchor-heading" aria-labelledby="sfall_func0show_window"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func0(“show_window”)</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">"show_window"</span><span class="p">)</span>
</code></pre></div></div> <p>Displays the script window previously hidden with the <code class="language-plaintext highlighter-rouge">sfall_func0("hide_window")</code> function.</p><hr /> <h3 class="d-inline-block" id="sfall_func1hide_window-string-winname"> <a href="#sfall_func1hide_window-string-winname" class="anchor-heading" aria-labelledby="sfall_func1hide_window-string-winname"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func1(“hide_window”, string winName)</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">"hide_window"</span><span class="p">)</span> </code></pre></div></div> <p>Displays the script window previously hidden with the <code class="language-plaintext highlighter-rouge">sfall_func0("hide_window")</code> function.</p><hr /> <h3 class="d-inline-block" id="sfall_func1hide_window-string-winname"> <a href="#sfall_func1hide_window-string-winname" class="anchor-heading" aria-labelledby="sfall_func1hide_window-string-winname"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func1(“hide_window”, string winName)</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">"hide_window"</span><span class="p">)</span>
</code></pre></div></div> <p>Hides the specified script window.</p> <ul> <li>winName: the window name, assigned to the window by the <code class="language-plaintext highlighter-rouge">CreateWin/create_win</code> function</li> </ul><hr /> <h3 class="d-inline-block" id="sfall_func1remove_timer_event-int-fixedparam"> <a href="#sfall_func1remove_timer_event-int-fixedparam" class="anchor-heading" aria-labelledby="sfall_func1remove_timer_event-int-fixedparam"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func1(“remove_timer_event”, int fixedParam)</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_func1</span><span class="p">(</span><span class="s">"remove_timer_event"</span><span class="p">,</span> <span class="kt">int</span> <span class="n">fixedParam</span><span class="p">)</span> </code></pre></div></div> <p>Hides the specified script window.</p> <ul> <li>winName: the window name, assigned to the window by the <code class="language-plaintext highlighter-rouge">CreateWin/create_win</code> function</li> </ul><hr /> <h3 class="d-inline-block" id="sfall_func1remove_timer_event-int-fixedparam"> <a href="#sfall_func1remove_timer_event-int-fixedparam" class="anchor-heading" aria-labelledby="sfall_func1remove_timer_event-int-fixedparam"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sfall_func1(“remove_timer_event”, int fixedParam)</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_func1</span><span class="p">(</span><span class="s">"remove_timer_event"</span><span class="p">,</span> <span class="kt">int</span> <span class="n">fixedParam</span><span class="p">)</span>