duckengine
Version:
A 2D Game Engine for the web.
116 lines • 60.1 kB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ParticleEmitter | DuckEngine - v2.1.0</title><meta name="description" content="Documentation for DuckEngine - v2.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">DuckEngine - v2.1.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">DuckEngine - v2.1.0</a></li><li><a href="../modules/core_gameobjects_particles_particleEmitter.html">core/gameobjects/particles/particleEmitter</a></li><li><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html">ParticleEmitter</a></li></ul><h1>Class ParticleEmitter</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>classdesc</dt><dd><p>Creates a DuckEngine ParticleEmitter</p>
</dd><dt>description</dt><dd><p>The ParticleEmitter Class. Emits, creates, and destroys particles</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ParticleEmitter</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#amount" class="tsd-kind-icon">amount</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#emitting" class="tsd-kind-icon">emitting</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#floatRangeX" class="tsd-kind-icon">float<wbr/>RangeX</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#floatRangeY" class="tsd-kind-icon">float<wbr/>RangeY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#game" class="tsd-kind-icon">game</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#particle" class="tsd-kind-icon">particle</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#rangeX" class="tsd-kind-icon">rangeX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#rangeY" class="tsd-kind-icon">rangeY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#scene" class="tsd-kind-icon">scene</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#createOne" class="tsd-kind-icon">create<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#emitFor" class="tsd-kind-icon">emit<wbr/>For</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#float" class="tsd-kind-icon">float</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#keepEmitting" class="tsd-kind-icon">keep<wbr/>Emitting</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#offloadBounds" class="tsd-kind-icon">offload<wbr/>Bounds</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#offloadMaxAge" class="tsd-kind-icon">offload<wbr/>Max<wbr/>Age</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#offloadMaxAmount" class="tsd-kind-icon">offload<wbr/>Max<wbr/>Amount</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#setFillColor" class="tsd-kind-icon">set<wbr/>Fill<wbr/>Color</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#setImagePath" class="tsd-kind-icon">set<wbr/>Image<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#setRange" class="tsd-kind-icon">set<wbr/>Range</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#setVelocity" class="tsd-kind-icon">set<wbr/>Velocity</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#stopEmit" class="tsd-kind-icon">stop<wbr/>Emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html#wobble" class="tsd-kind-icon">wobble</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Particle<wbr/>Emitter<span class="tsd-signature-symbol">(</span>particle<span class="tsd-signature-symbol">: </span><a href="core_gameobjects_particles_particle.Particle.html" class="tsd-signature-type" data-tsd-kind="Class">Particle</a>, rangeX<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a>, rangeY<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, game<span class="tsd-signature-symbol">: </span><a href="core_game.Game.html" class="tsd-signature-type" data-tsd-kind="Class">Game</a>, scene<span class="tsd-signature-symbol">: </span><a href="core_scene.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a>, autoCreate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">ParticleEmitter</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L103">core/gameobjects/particles/particleEmitter.ts:103</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Creates ParticleEmitter instance</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>particle: <a href="core_gameobjects_particles_particle.Particle.html" class="tsd-signature-type" data-tsd-kind="Class">Particle</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Base particle that is cloned and modified from</p>
</div></div></li><li><h5>rangeX: <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Where the new emitted particles x position is. A range of 2 values</p>
</div></div></li><li><h5>rangeY: <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Where the new emitted particles y position is. A range of 2 values</p>
</div></div></li><li><h5>amount: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Amount of starting particles</p>
</div></div></li><li><h5>game: <a href="core_game.Game.html" class="tsd-signature-type" data-tsd-kind="Class">Game</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Game instance</p>
</div></div></li><li><h5>scene: <a href="core_scene.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Scene instance</p>
</div></div></li><li><h5>autoCreate: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="core_gameobjects_particles_particleEmitter.ParticleEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">ParticleEmitter</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="amount" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> amount</h3><div class="tsd-signature tsd-kind-icon">amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L46">core/gameobjects/particles/particleEmitter.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>The starting amount of particle</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emitting" class="tsd-anchor"></a><h3>emitting</h3><div class="tsd-signature tsd-kind-icon">emitting<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L78">core/gameobjects/particles/particleEmitter.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Determines if the ParticleEmitter is emitting or not</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L86">core/gameobjects/particles/particleEmitter.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Determines if the ParticleEmitter is enabled or not</p>
</dd><dt>since</dt><dd><p>2.0.0</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="floatRangeX" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> float<wbr/>RangeX</h3><div class="tsd-signature tsd-kind-icon">float<wbr/>RangeX<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L88">core/gameobjects/particles/particleEmitter.ts:88</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="floatRangeY" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> float<wbr/>RangeY</h3><div class="tsd-signature tsd-kind-icon">float<wbr/>RangeY<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L89">core/gameobjects/particles/particleEmitter.ts:89</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="game" class="tsd-anchor"></a><h3>game</h3><div class="tsd-signature tsd-kind-icon">game<span class="tsd-signature-symbol">:</span> <a href="core_game.Game.html" class="tsd-signature-type" data-tsd-kind="Class">Game</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L62">core/gameobjects/particles/particleEmitter.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Game instance</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L21">core/gameobjects/particles/particleEmitter.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>A unique identifier for the ParticleEmitter</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="list" class="tsd-anchor"></a><h3>list</h3><div class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">:</span> <a href="core_gameobjects_particles_particle.Particle.html" class="tsd-signature-type" data-tsd-kind="Class">Particle</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L54">core/gameobjects/particles/particleEmitter.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>The list of current particles</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="particle" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> particle</h3><div class="tsd-signature tsd-kind-icon">particle<span class="tsd-signature-symbol">:</span> <a href="core_gameobjects_particles_particle.Particle.html" class="tsd-signature-type" data-tsd-kind="Class">Particle</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L22">core/gameobjects/particles/particleEmitter.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="rangeX" class="tsd-anchor"></a><h3>rangeX</h3><div class="tsd-signature tsd-kind-icon">rangeX<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L30">core/gameobjects/particles/particleEmitter.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>A range of numbers where particle x pos will be</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="rangeY" class="tsd-anchor"></a><h3>rangeY</h3><div class="tsd-signature tsd-kind-icon">rangeY<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L38">core/gameobjects/particles/particleEmitter.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>A range of numbers where particle y pos will be</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="scene" class="tsd-anchor"></a><h3>scene</h3><div class="tsd-signature tsd-kind-icon">scene<span class="tsd-signature-symbol">:</span> <a href="core_scene.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L70">core/gameobjects/particles/particleEmitter.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Scene instance</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a><h3>create</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L138">core/gameobjects/particles/particleEmitter.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Creates an amount of particles</p>
</dd><dt>since</dt><dd><p>2.1.0</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOne" class="tsd-anchor"></a><h3>create<wbr/>One</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>One<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L149">core/gameobjects/particles/particleEmitter.ts:149</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Creates one particle</p>
</dd><dt>since</dt><dd><p>2.1.0</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L192">core/gameobjects/particles/particleEmitter.ts:192</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Starts emitting particles</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="emitFor" class="tsd-anchor"></a><h3>emit<wbr/>For</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">emit<wbr/>For<span class="tsd-signature-symbol">(</span>ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L213">core/gameobjects/particles/particleEmitter.ts:213</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Starts emitting particles for a certain duration</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ms: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Duration in milliseconds</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="float" class="tsd-anchor"></a><h3>float</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">float<span class="tsd-signature-symbol">(</span>rangeVX<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a>, rangeVY<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L451">core/gameobjects/particles/particleEmitter.ts:451</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Sets the floatVelocity of all particles in between a range</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>rangeVX: <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A range of 2 values for the floatVelocity.x, randomly chosen between that range</p>
</div></div></li><li><h5>rangeVY: <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A range of 2 values for the floatVelocity.y, randomly chosen between that range</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="keepEmitting" class="tsd-anchor"></a><h3>keep<wbr/>Emitting</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">keep<wbr/>Emitting<span class="tsd-signature-symbol">(</span>intervalMS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, limitTo<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L258">core/gameobjects/particles/particleEmitter.ts:258</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Spawns new particles after the initial particles</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>intervalMS: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>How often a new particle gets spawned</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limitTo: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="offloadBounds" class="tsd-anchor"></a><h3>offload<wbr/>Bounds</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">offload<wbr/>Bounds<span class="tsd-signature-symbol">(</span>bounds<span class="tsd-signature-symbol">: </span><a href="../interfaces/index.Duck.Types.Math.BoundsLike.html" class="tsd-signature-type" data-tsd-kind="Interface">BoundsLike</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L301">core/gameobjects/particles/particleEmitter.ts:301</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Offloads particles based on position</p>
</dd><dt>since</dt><dd><p>2.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bounds: <a href="../interfaces/index.Duck.Types.Math.BoundsLike.html" class="tsd-signature-type" data-tsd-kind="Interface">BoundsLike</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The Bounds of the particles, a BoundsLike object that causes a particle to be offloaded</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="offloadMaxAge" class="tsd-anchor"></a><h3>offload<wbr/>Max<wbr/>Age</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">offload<wbr/>Max<wbr/>Age<span class="tsd-signature-symbol">(</span>ageInSeconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L371">core/gameobjects/particles/particleEmitter.ts:371</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Offloads particles based on how many seconds they existed for</p>
</dd><dt>since</dt><dd><p>1.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ageInSeconds: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Max amount of seconds a particle existed for</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="offloadMaxAmount" class="tsd-anchor"></a><h3>offload<wbr/>Max<wbr/>Amount</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">offload<wbr/>Max<wbr/>Amount<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L275">core/gameobjects/particles/particleEmitter.ts:275</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Pops particles from the list if too many particles exist</p>
</dd><dt>since</dt><dd><p>1.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>limit: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setFillColor" class="tsd-anchor"></a><h3>set<wbr/>Fill<wbr/>Color</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Fill<wbr/>Color<span class="tsd-signature-symbol">(</span>fillColor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L470">core/gameobjects/particles/particleEmitter.ts:470</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Sets the fillColor of all particles</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fillColor: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Color</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setImagePath" class="tsd-anchor"></a><h3>set<wbr/>Image<wbr/>Path</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Image<wbr/>Path<span class="tsd-signature-symbol">(</span>imagePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L482">core/gameobjects/particles/particleEmitter.ts:482</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Sets the imagePath of all particles</p>
</dd><dt>since</dt><dd><p>1.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>imagePath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Image path</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setRange" class="tsd-anchor"></a><h3>set<wbr/>Range</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Range<span class="tsd-signature-symbol">(</span>rangeX<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a>, rangeY<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L227">core/gameobjects/particles/particleEmitter.ts:227</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Sets the new or old particles' position range</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>rangeX: <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Where the new emitted particles x position is. A range of 2 values</p>
</div></div></li><li><h5>rangeY: <a href="../modules/index.Duck.Types.ParticleEmitter.html#Range" class="tsd-signature-type" data-tsd-kind="Type alias">Range</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Where the new emitted particles y position is. A range of 2 values</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setVelocity" class="tsd-anchor"></a><h3>set<wbr/>Velocity</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Velocity<span class="tsd-signature-symbol">(</span>axis<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"x"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"y"</span>, v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L404">core/gameobjects/particles/particleEmitter.ts:404</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Sets the velocity of all particles</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>axis: <span class="tsd-signature-type">"x"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"y"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>'x' or 'y' axis to change the velocity of all particles</p>
</div></div></li><li><h5>v: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Value to set the velocity of all particles</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stopEmit" class="tsd-anchor"></a><h3>stop<wbr/>Emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">stop<wbr/>Emit<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L202">core/gameobjects/particles/particleEmitter.ts:202</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Stops emitting particles</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="wobble" class="tsd-anchor"></a><h3>wobble</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">wobble<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/gameobjects/particles/particleEmitter.ts#L416">core/gameobjects/particles/particleEmitter.ts:416</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>ParticleEmitter</p>
</dd><dt>description</dt><dd><p>Wobbles the particle on a random direction and axis</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>v: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Value to set the wobble velocity to</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animation.html">core/animation/animation</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationFrame.html">core/animation/animation<wbr/>Frame</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationManager.html">core/animation/animation<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationState.html">core/animation/animation<wbr/>State</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_stateMachine.html">core/animation/state<wbr/>Machine</a></li><li class=" tsd-kind-module"><a href="../modules/core_camera_camera.html">core/camera/camera</a></li><li class=" tsd-kind-module"><a href="../modules/core_cutscene_cutscene.html">core/cutscene/cutscene</a></li><li class=" tsd-kind-module"><a href="../modules/core_debug_debug.html">core/debug/debug</a></li><li class=" tsd-kind-module"><a href="../modules/core_display_displayManager.html">core/display/display<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_effect.html">core/effect/effect</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_preset_explosion.html">core/effect/preset/explosion</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_preset_smoke.html">core/effect/preset/smoke</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_eventEmitter.html">core/events/event<wbr/>Emitter</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_events.html">core/events/events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_displayEvents.html">core/events/main/display<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_gameEvents.html">core/events/main/game<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_rendererEvents.html">core/events/main/renderer<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_buttonEvents.html">core/events/other/button<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_cutsceneEvents.html">core/events/other/cutscene<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_groupEvents.html">core/events/other/group<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_game.html">core/game</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_circle.html">core/gameobjects/circle</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_gameObject.html">core/gameobjects/game<wbr/>Object</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_misc_canvasModulate.html">core/gameobjects/misc/canvas<wbr/>Modulate</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_particles_particle.html">core/gameobjects/particles/particle</a></li><li class="current tsd-kind-module"><a href="../modules/core_gameobjects_particles_particleEmitter.html">core/gameobjects/particles/particle<wbr/>Emitter</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_rect.html">core/gameobjects/rect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_roundrect.html">core/gameobjects/roundrect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_sprite.html">core/gameobjects/sprite</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_button.html">core/gameobjects/ui/button</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_imageRect.html">core/gameobjects/ui/image<wbr/>Rect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_panel.html">core/gameobjects/ui/panel</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_text.html">core/gameobjects/ui/text</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_ui.html">core/gameobjects/ui/ui</a></li><li class=" tsd-kind-module"><a href="../modules/core_group_group.html">core/group/group</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_input.html">core/input/input</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_keyboardInput.html">core/input/keyboard<wbr/>Input</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_models_key.html">core/input/models/key</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_models_mouse.html">core/input/models/mouse</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_mouseInput.html">core/input/mouse<wbr/>Input</a></li><li class=" tsd-kind-module"><a href="../modules/core_lights_staticLight.html">core/lights/static<wbr/>Light</a></li><li class=" tsd-kind-module"><a href="../modules/core_loader_loader.html">core/loader/loader</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_map.html">core/map/map</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tile.html">core/map/tile</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tilelayer.html">core/map/tilelayer</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tilemap.html">core/map/tilemap</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tileset.html">c