Files
sfall/animations/index.html
T

11 lines
25 KiB
HTML
Raw Normal View History

2026-01-27 07:17:52 +00:00
<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/sfall/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/sfall/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li:not(:nth-child(9)) > a, .site-nav > ul.nav-list:first-child > li > ul > li a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(9) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(9) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(9) > ul.nav-list { display: block; } </style> <script src="/sfall/assets/js/vendor/lunr.min.js"></script> <script src="/sfall/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" href="/sfall/favicon.ico" type="image/x-icon"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Animations | sfall</title> <meta name="generator" content="Jekyll v3.9.0" /> <meta property="og:title" content="Animations" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Sfall documentation" /> <meta property="og:description" content="Sfall documentation" /> <link rel="canonical" href="/sfall/animations/" /> <meta property="og:url" content="/sfall/animations/" /> <meta property="og:site_name" content="sfall" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="Animations" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"Sfall documentation","headline":"Animations","url":"/sfall/animations/"}</script> <!-- End Jekyll SEO tag --> <link rel="apple-touch-icon" sizes="180x180" href="/assets/favicon/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon/favicon-16x16.png"> <link rel="manifest" href="/assets/favicon/site.webmanifest"> <link rel="mask-icon" href="/assets/favicon/safari-pinned-tab.svg" color="#5bbad5"> <meta name="msapplication-TileColor" content="#da532c"> <meta name="msapplication-config" content="/assets/favicon/browserconfig.xml"> <meta name="theme-color" content="#ffffff"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24
2023-12-27 05:26:09 +00:00
</code></pre></div></div> <p>Works exactly like <code class="language-plaintext highlighter-rouge">reg_anim_animate</code> but the object will automatically disappear after the last animation frame (but not destroyed).</p> <ul> <li><code class="language-plaintext highlighter-rouge">delay</code>: delay from the previous animation. A value of -1 will execute the specified animation immediately after the previous one in the sequence ends.</li> </ul><hr /> <h3 class="d-inline-block" id="reg_anim_animate_and_move"> <a href="#reg_anim_animate_and_move" class="anchor-heading" aria-labelledby="reg_anim_animate_and_move"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_animate_and_move</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">reg_anim_animate_and_move</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="p">,</span> <span class="kt">int</span> <span class="n">animID</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 the specified animation while simultaneously moving the object to the given tile.</p> <ul> <li><code class="language-plaintext highlighter-rouge">delay</code>: delay from the previous animation. A value of -1 will execute the specified animation immediately after the previous one in the sequence ends.</li> </ul><hr /> <h3 id="reg_anim_callback"> <a href="#reg_anim_callback" class="anchor-heading" aria-labelledby="reg_anim_callback"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_callback</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_callback</span><span class="p">(</span><span class="n">procedure</span> <span class="n">proc</span><span class="p">)</span>
2021-06-01 04:05:32 +00:00
</code></pre></div></div> <p>Adds the given procedure to an animation sequence-list and executes it in the registered sequence.</p><hr /> <h3 id="reg_anim_change_fid"> <a href="#reg_anim_change_fid" class="anchor-heading" aria-labelledby="reg_anim_change_fid"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>reg_anim_change_fid</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_change_fid</span><span class="p">(</span><span class="n">ObjectPtr</span><span class="p">,</span> <span class="kt">int</span> <span class="n">FID</span><span class="p">,</span> <span class="kt">int</span> <span class="n">delay</span><span class="p">)</span>
2022-04-07 13:19:56 +00:00
</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>
2021-06-01 04:05:32 +00:00
</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>
2022-04-07 13:19:56 +00:00
</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 critters 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>
2026-01-27 07:17:52 +00:00
</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>