profectus-docs/assets/api_modules_features_particles.md.763b2b91.js

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Module: features/particles/particles","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/particles.md","lastUpdated":null}'),l={name:"api/modules/features/particles.md"},o=r('<h1 id="module-features-particles-particles" tabindex="-1">Module: features/particles/particles <a class="header-anchor" href="#module-features-particles-particles" aria-label="Permalink to &quot;Module: features/particles/particles&quot;">​</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;">​</a></h2><h3 id="baseparticles" tabindex="-1">BaseParticles <a class="header-anchor" href="#baseparticles" aria-label="Permalink to &quot;BaseParticles&quot;">​</a></h3><p>• <strong>BaseParticles</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./particles#particlesoptions">ParticlesOptions</a> to create an <a href="./particles#particles">Particles</a>.</p><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>[Component]</code></td><td style="text-align:left;"><a href="./feature#genericcomponent"><code>GenericComponent</code></a></td><td style="text-align:left;">The Vue component used to render this feature.</td></tr><tr><td style="text-align:left;"><code>[GatherProps]</code></td><td style="text-align:left;">() =&gt; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>unknown</code>&gt;</td><td style="text-align:left;">A function to gather the props the vue component requires for this feature.</td></tr><tr><td style="text-align:left;"><code>addEmitter</code></td><td style="text-align:left;">(<code>config</code>: <code>EmitterConfigV3</code>) =&gt; <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>Emitter</code>&gt;</td><td style="text-align:left;">A function to asynchronously add an emitter to the canvas. The returned emitter can then be positioned as appropriate and started. <strong><code>See</code></strong> <a href="./particles#particles">Particles</a></td></tr><tr><td style="text-align:left;"><code>app</code></td><td style="text-align:left;"><code>Ref</code>&lt;<code>null</code> | <code>Application</code>&gt;</td><td style="text-align:left;">The Pixi.JS Application powering this particles canvas.</td></tr><tr><td style="text-align:left;"><code>id</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;">An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</td></tr><tr><td style="text-align:left;"><code>type</code></td><td style="text-align:left;">typeof <a href="./particles#particlestype"><code>ParticlesType</code></a></td><td style="text-align:left;">A symbol that helps identify features of the same type.</td></tr></tbody></table><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/b666e0c/src/features/particles/particles.tsx#L31" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:31</a></p><hr><h3 id="particlesoptions" tabindex="-1">ParticlesOptions <a class="header-anchor" href="#particlesoptions" aria-label="Permalink to &quot;ParticlesOptions&quot;">​</a></h3><p>• <strong>ParticlesOptions</strong>: <code>Object</code></p><p>An object that configures <a href="./particles#particles">Particles</a>.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th st