profectus-docs/assets/api_interfaces_features_particles_particles.BaseParticles.md.1d33b966.js

1 line
8 KiB
JavaScript

import{_ as e,c as t,o,a as r}from"./app.e5a3543f.js";const g='{"title":"Interface: BaseParticles","description":"","frontmatter":{},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"[Component]","slug":"component"},{"level":3,"title":"app","slug":"app"},{"level":3,"title":"id","slug":"id"},{"level":3,"title":"type","slug":"type"},{"level":2,"title":"Methods","slug":"methods"},{"level":3,"title":"[GatherProps]","slug":"gatherprops"},{"level":3,"title":"addEmitter","slug":"addemitter"}],"relativePath":"api/interfaces/features/particles/particles.BaseParticles.md"}',d={},c=r('<h1 id="interface-baseparticles" tabindex="-1">Interface: BaseParticles <a class="header-anchor" href="#interface-baseparticles" aria-hidden="true">#</a></h1><p><a href="./../../../modules/features/particles/particles.html">features/particles/particles</a>.BaseParticles</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-hidden="true">#</a></h3><p>\u2022 <strong>[Component]</strong>: <code>DefineComponent</code>&lt;{ <code>classes</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;&gt; ; <code>id</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>StringConstructor</code> = String } ; <code>onContainerResized</code>: <code>PropType</code>&lt;(<code>rect</code>: <code>DOMRect</code>) =&gt; <code>void</code>&gt; ; <code>onHotReload</code>: <code>PropType</code>&lt;<code>VoidFunction</code>&gt; ; <code>onInit</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;(<code>app</code>: <code>Application</code>) =&gt; <code>void</code>&gt; } ; <code>style</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;&gt; }, { <code>resizeListener</code>: <code>Ref</code>&lt;<code>null</code> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement" target="_blank" rel="noopener noreferrer"><code>HTMLElement</code></a>&gt; ; <code>unref</code>: &lt;T&gt;(<code>ref</code>: <code>T</code> | <code>Ref</code>&lt;<code>T</code>&gt;) =&gt; <code>T</code> }, <code>unknown</code>, {}, {}, <code>ComponentOptionsMixin</code>, <code>ComponentOptionsMixin</code>, <code>Record</code>&lt;<code>string</code>, <code>any</code>&gt;, <code>string</code>, <code>PublicProps</code>, <code>Readonly</code>&lt;<code>ExtractPropTypes</code>&lt;{ <code>classes</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;&gt; ; <code>id</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>StringConstructor</code> = String } ; <code>onContainerResized</code>: <code>PropType</code>&lt;(<code>rect</code>: <code>DOMRect</code>) =&gt; <code>void</code>&gt; ; <code>onHotReload</code>: <code>PropType</code>&lt;<code>VoidFunction</code>&gt; ; <code>onInit</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;(<code>app</code>: <code>Application</code>) =&gt; <code>void</code>&gt; } ; <code>style</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;&gt; }&gt;&gt;, {}&gt;</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/2e3f1de/src/features/particles/particles.tsx#L30" target="_blank" rel="noopener noreferrer">profectus/src/features/particles/particles.tsx:30</a></p><hr><h3 id="app" tabindex="-1">app <a class="header-anchor" href="#app" aria-hidden="true">#</a></h3><p>\u2022 <strong>app</strong>: <code>Ref</code>&lt;<code>null</code> | <code>Application</code>&gt;</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/2e3f1de/src/features/particles/particles.tsx#L27" target="_blank" rel="noopener noreferrer">profectus/src/features/particles/particles.tsx:27</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-hidden="true">#</a></h3><p>\u2022 <strong>id</strong>: <code>string</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/2e3f1de/src/features/particles/particles.tsx#L26" target="_blank" rel="noopener noreferrer">profectus/src/features/particles/particles.tsx:26</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-hidden="true">#</a></h3><p>\u2022 <strong>type</strong>: typeof <a href="./../../../modules/features/particles/particles.html#particlestype"><code>ParticlesType</code></a></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/particles/particles.tsx#L29" target="_blank" rel="noopener noreferrer">profectus/src/features/particles/particles.tsx:29</a></p><h2 id="methods" tabindex="-1">Methods <a class="header-anchor" href="#methods" aria-hidden="true">#</a></h2><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-hidden="true">#</a></h3><p>\u25B8 <strong>[GatherProps]</strong>(): <code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;</p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/particles/particles.tsx#L31" target="_blank" rel="noopener noreferrer">profectus/src/features/particles/particles.tsx:31</a></p><hr><h3 id="addemitter" tabindex="-1">addEmitter <a class="header-anchor" href="#addemitter" aria-hidden="true">#</a></h3><p>\u25B8 <strong>addEmitter</strong>(<code>config</code>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noopener noreferrer"><code>Promise</code></a>&lt;<code>Emitter</code>&gt;</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>config</code></td><td style="text-align:left;"><code>EmitterConfigV3</code></td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-hidden="true">#</a></h4><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noopener noreferrer"><code>Promise</code></a>&lt;<code>Emitter</code>&gt;</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/particles/particles.tsx#L28" target="_blank" rel="noopener noreferrer">profectus/src/features/particles/particles.tsx:28</a></p>',38),a=[c];function s(i,n,l,p,h,f){return o(),t("div",null,a)}var m=e(d,[["render",s]]);export{g as __pageData,m as default};