profectus-docs/assets/api_interfaces_game_layers.LayerEvents.md.9623ae3c.js

1 line
5.2 KiB
JavaScript

import{_ as e,c as t,o as a,a as r}from"./app.ab34650d.js";const y=JSON.parse('{"title":"Interface: LayerEvents","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"postUpdate","slug":"postupdate"},{"level":3,"title":"preUpdate","slug":"preupdate"},{"level":3,"title":"update","slug":"update"}],"relativePath":"api/interfaces/game/layers.LayerEvents.md","lastUpdated":null}'),d={name:"api/interfaces/game/layers.LayerEvents.md"},n=r('<h1 id="interface-layerevents" tabindex="-1">Interface: LayerEvents <a class="header-anchor" href="#interface-layerevents" aria-hidden="true">#</a></h1><p><a href="./../../modules/game/layers.html">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-hidden="true">#</a></h2><h3 id="postupdate" tabindex="-1">postUpdate <a class="header-anchor" href="#postupdate" aria-hidden="true">#</a></h3><p>\u2022 <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-hidden="true">#</a></h4><p>\u25B8 (<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-hidden="true">#</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-hidden="true">#</a></h5><p><code>void</code></p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L70" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:70</a></p><hr><h3 id="preupdate" tabindex="-1">preUpdate <a class="header-anchor" href="#preupdate" aria-hidden="true">#</a></h3><p>\u2022 <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-hidden="true">#</a></h4><p>\u25B8 (<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-hidden="true">#</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-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L60" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:60</a></p><hr><h3 id="update" tabindex="-1">update <a class="header-anchor" href="#update" aria-hidden="true">#</a></h3><p>\u2022 <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-hidden="true">#</a></h4><p>\u25B8 (<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-hidden="true">#</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-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L65" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:65</a></p>',39),i=[n];function s(o,h,c,l,p,f){return a(),t("div",null,i)}var g=e(d,[["render",s]]);export{y as __pageData,g as default};