profectus-docs/assets/api_modules_features_particles_particles.md.c84a0b31.js

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Module: features/particles/particles","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/particles/particles.md","lastUpdated":null}'),s={name:"api/modules/features/particles/particles.md"},i=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="components" tabindex="-1">Components <a class="header-anchor" href="#components" aria-label="Permalink to &quot;Components&quot;">​</a></h2><ul><li><a href="./ParticlesComponent">Particles</a></li></ul><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;">​</a></h2><ul><li><a href="../../../interfaces/features/particles/particles.BaseParticles">BaseParticles</a></li><li><a href="../../../interfaces/features/particles/particles.ParticlesOptions">ParticlesOptions</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;">​</a></h2><h3 id="genericparticles" tabindex="-1">GenericParticles <a class="header-anchor" href="#genericparticles" aria-label="Permalink to &quot;GenericParticles&quot;">​</a></h3><p>Ƭ <strong>GenericParticles</strong>: <a href="./particles#particles"><code>Particles</code></a>&lt;<a href="../../../interfaces/features/particles/particles.ParticlesOptions"><code>ParticlesOptions</code></a>&gt;</p><p>A type that matches any valid <a href="./particles#particles">Particles</a> object.</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/features/particles/particles.tsx#L63" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:63</a></p><hr><h3 id="particles" tabindex="-1">Particles <a class="header-anchor" href="#particles" aria-label="Permalink to &quot;Particles&quot;">​</a></h3><p>Ƭ <strong>Particles</strong>&lt;<code>T</code>&gt;: <a href="./../feature#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/particles/particles.BaseParticles"><code>BaseParticles</code></a>, { <code>classes</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>style</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; }&gt;</p><p>An object that represents a feature that display particle effects on the screen. The config should typically be gotten by designing the effect using the <a href="https://pixijs.io/pixi-particles-editor/" target="_blank" rel="noreferrer">online particle effect editor</a> and passing it into the upgradeConfig from @pixi/particle-emitter.</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type parameters&quot;">​</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>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/particles/particles.ParticlesOptions"><code>ParticlesOptions</code></a></td></tr></tbody></table><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/features/particles/particles.tsx#L54" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:54</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-label="Permalink to &quot;Variables&quot;">​</a></h2><h3 id="particlestype" tabindex="-1">ParticlesType <a class="header-anchor" href="#particlestype" aria-label="Permalink to &quot;ParticlesType&quot;">​</a></h3><p>• <code>Const</code> <strong>ParticlesType</strong>: typeof <a href="./particles#particlestype"><code>ParticlesType</code></a></p><p>A symbol used to identify <a href="./particles#particles">Particles</a> features.</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/features/particles/particles.tsx#L12" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:12</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to &quot;Functions&quot;">​</a></h2><h3 id="createparticles" tabindex="-1">createParticles <a class="header-anchor" href="#createparticles" aria-label="Permalink to &quot;createParticles&quot;">​</a></h3><p>▸ <strong>createParticles</strong>&lt;<code>T</code>&gt;(<code>optionsFunc?</code>): <a href="./particles#particles"><code>Particles</code></a>&lt;<code>T</code>&gt;</p><p>Lazily creates particles with the given options.</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-label="Permalink to &quot;Type parameters&quot;">​</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>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/particles/particles.ParticlesOptions"><code>ParticlesOptions</code></a></td></tr></tbody></table><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><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>optionsFunc?</code></td><td style="text-align:left;"><a href="./../feature#optionsfunc"><code>OptionsFunc</code></a>&lt;<code>T</code>, <a href="../../../interfaces/features/particles/particles.BaseParticles"><code>BaseParticles</code></a>, <a href="./particles#genericparticles"><code>GenericParticles</code></a>&gt;</td><td style="text-align:left;">Particles options.</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><a href="./particles#particles"><code>Particles</code></a>&lt;<code>T</code>&gt;</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L69" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:69</a></p>',37),l=[i];function c(o,n,d,p,h,f){return a(),t("div",null,l)}const m=e(s,[["render",c]]);export{b as __pageData,m as default};