1 line
7.4 KiB
JavaScript
1 line
7.4 KiB
JavaScript
import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: BaseParticles","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/particles/particles.BaseParticles.md","lastUpdated":null}'),o={name:"api/interfaces/features/particles/particles.BaseParticles.md"},i=r('<h1 id="interface-baseparticles" tabindex="-1">Interface: BaseParticles <a class="header-anchor" href="#interface-baseparticles" aria-label="Permalink to "Interface: BaseParticles""></a></h1><p><a href="./../../../modules/features/particles/particles">features/particles/particles</a>.BaseParticles</p><p>The properties that are added onto a processed <a href="./particles.ParticlesOptions">ParticlesOptions</a> to create an <a href="./../../../modules/features/particles/particles#particles">Particles</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to "[Component]""></a></h3><p>• <strong>[Component]</strong>: <a href="./../../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render this feature.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L45" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:45</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to "[GatherProps]""></a></h3><p>• <strong>[GatherProps]</strong>: () => <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (): <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>></p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L47" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:47</a></p><hr><h3 id="addemitter" tabindex="-1">addEmitter <a class="header-anchor" href="#addemitter" aria-label="Permalink to "addEmitter""></a></h3><p>• <strong>addEmitter</strong>: (<code>config</code>: <code>EmitterConfigV3</code>) => <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a><<code>Emitter</code>></p><h4 id="type-declaration-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>config</code>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a><<code>Emitter</code>></p><p>A function to asynchronously add an emitter to the canvas. The returned emitter can then be positioned as appropriate and started.</p><p><strong><code>See</code></strong></p><p><a href="./../../../modules/features/particles/particles#particles">Particles</a></p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h5><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><h5 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h5><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a><<code>Emitter</code>></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L41" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:41</a></p><hr><h3 id="app" tabindex="-1">app <a class="header-anchor" href="#app" aria-label="Permalink to "app""></a></h3><p>• <strong>app</strong>: <code>Ref</code><<code>null</code> | <code>Application</code>></p><p>The Pixi.JS Application powering this particles canvas.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L35" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:35</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L33" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:33</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><p>• <strong>type</strong>: typeof <a href="./../../../modules/features/particles/particles#particlestype"><code>ParticlesType</code></a></p><p>A symbol that helps identify features of the same type.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L43" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:43</a></p>',51),s=[i];function n(c,l,d,p,h,f){return a(),t("div",null,s)}const m=e(o,[["render",n]]);export{b as __pageData,m as default};
|