profectus-docs/assets/api_interfaces_game_layers.LayerEvents.md.eb3ef8a4.js

1 line
5.5 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Interface: LayerEvents","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/layers.LayerEvents.md","lastUpdated":null}'),d={name:"api/interfaces/game/layers.LayerEvents.md"},o=r('<h1 id="interface-layerevents" tabindex="-1">Interface: LayerEvents <a class="header-anchor" href="#interface-layerevents" aria-label="Permalink to &quot;Interface: LayerEvents&quot;"></a></h1><p><a href="./../../modules/game/layers">game/layers</a>.LayerEvents</p><p>All types of events able to be sent or emitted from a layer&#39;s emitter.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;"></a></h2><h3 id="postupdate" tabindex="-1">postUpdate <a class="header-anchor" href="#postupdate" aria-label="Permalink to &quot;postUpdate&quot;"></a></h3><p>• <strong>postUpdate</strong>: (<code>diff</code>: <code>number</code>) =&gt; <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;"></a></h4><p>▸ (<code>diff</code>): <code>void</code></p><p>Sent every game tick, after the update event. Intended for checking state.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>diff</code></td><td style="text-align:left;"><code>number</code></td><td style="text-align:left;">The delta time since last tick, in ms.</td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h5><p><code>void</code></p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/layers.tsx#L70" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:70</a></p><hr><h3 id="preupdate" tabindex="-1">preUpdate <a class="header-anchor" href="#preupdate" aria-label="Permalink to &quot;preUpdate&quot;"></a></h3><p>• <strong>preUpdate</strong>: (<code>diff</code>: <code>number</code>) =&gt; <code>void</code></p><h4 id="type-declaration-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-label="Permalink to &quot;Type declaration&quot;"></a></h4><p>▸ (<code>diff</code>): <code>void</code></p><p>Sent every game tick, before the update event. Intended for &quot;generation&quot; type actions.</p><h5 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to &quot;Parameters&quot;"></a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>diff</code></td><td style="text-align:left;"><code>number</code></td><td style="text-align:left;">The delta time since last tick, in ms.</td></tr></tbody></table><h5 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to &quot;Returns&quot;"></a></h5><p><code>void</code></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/layers.tsx#L60" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:60</a></p><hr><h3 id="update" tabindex="-1">update <a class="header-anchor" href="#update" aria-label="Permalink to &quot;update&quot;"></a></h3><p>• <strong>update</strong>: (<code>diff</code>: <code>number</code>) =&gt; <code>void</code></p><h4 id="type-declaration-2" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-2" aria-label="Permalink to &quot;Type declaration&quot;"></a></h4><p>▸ (<code>diff</code>): <code>void</code></p><p>Sent every game tick. Intended for &quot;automation&quot; type actions.</p><h5 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to &quot;Parameters&quot;"></a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>diff</code></td><td style="text-align:left;"><code>number</code></td><td style="text-align:left;">The delta time since last tick, in ms.</td></tr></tbody></table><h5 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to &quot;Returns&quot;"></a></h5><p><code>void</code></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/layers.tsx#L65" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:65</a></p>',39),n=[o];function i(l,s,c,h,p,f){return a(),t("div",null,n)}const b=e(d,[["render",i]]);export{m as __pageData,b as default};