A Game Object with an active state of <code>true</code> is processed by the Scenes UpdateList, if added to it.
An active object is one which is having its logic and internal systems updated.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.active</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19599</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="alpha"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>alpha</span><ahref="#alpha"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">alpha</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The alpha value of the Game Object.</p>
<p>This is a global value, impacting the entire Game Object, not just a region of it.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.alpha</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17109</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="angle"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>angle</span><ahref="#angle"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">angle</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The angle of this Game Object as expressed in degrees.</p>
<p>Phaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left
and -90 is up.</p>
<p>If you prefer to work in radians, see the <code>rotation</code> property instead.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.angle</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17505</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="blendMode"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>blend<wbr/>Mode</span><ahref="#blendMode"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">blend<wbr/>Mode</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">BlendModes</span></div><divclass="tsd-comment tsd-typography"><p>Sets the Blend Mode being used by this Game Object.</p>
<p>This can be a const, such as <code>Phaser.BlendModes.SCREEN</code>, or an integer, such as 4 (for Overlay)</p>
<p>Under WebGL only the following Blend Modes are available:</p>
<ul>
<li>NORMAL</li>
<li>ADD</li>
<li>MULTIPLY</li>
<li>SCREEN</li>
<li>ERASE</li>
</ul>
<p>Canvas has more available depending on browser support.</p>
<p>You can also create your own custom Blend Modes in WebGL.</p>
<p>Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending
on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
reasons try to be careful about the construction of your Scene and the frequency of which blend modes
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.blendMode</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17133</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="body"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>body</span><ahref="#body"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">body</span><spanclass="tsd-signature-symbol">:</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">null</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">BodyType</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">Body</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">StaticBody</span></div><divclass="tsd-comment tsd-typography"><p>If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.body</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19637</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="cameraFilter"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>camera<wbr/>Filter</span><ahref="#cameraFilter"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">camera<wbr/>Filter</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>A bitmask that controls if this Game Object is drawn by a Camera or not.
Not usually set directly, instead call <code>Camera.ignore</code>, however you can
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.cameraFilter</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19626</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="data"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>data</span><ahref="#data"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">data</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">DataManager</span></div><divclass="tsd-comment tsd-typography"><p>A Data Manager.
It allows you to store, query and get key/value paired information specific to this Game Object.
<code>null</code> by default. Automatically created if you use <code>getData</code> or <code>setData</code> or <code>setDataEnabled</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.data</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19612</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="depth"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>depth</span><ahref="#depth"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">depth</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.</p>
of Game Objects, without actually moving their position in the display list.</p>
<p>The default depth is zero. A Game Object with a higher depth
value will always render in front of one with a lower value.</p>
<p>Setting the depth will queue a depth sort event within the Scene.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.depth</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17231</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="displayHeight"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>display<wbr/>Height</span><ahref="#displayHeight"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">display<wbr/>Height</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The displayed height of this Game Object.</p>
<p>This value takes into account the scale factor.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.displayHeight</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17194</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="displayList"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>display<wbr/>List</span><ahref="#displayList"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">display<wbr/>List</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Layer</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">DisplayList</span></div><divclass="tsd-comment tsd-typography"><p>Holds a reference to the Display List that contains this Game Object.</p>
<p>This is set automatically when this Game Object is added to a Scene or Layer.</p>
<p>You should treat this property as being read-only.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.displayList</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19563</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="displayOriginX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>display<wbr/>OriginX</span><ahref="#displayOriginX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">display<wbr/>OriginX</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.displayOriginX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16699</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="displayOriginY"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>display<wbr/>OriginY</span><ahref="#displayOriginY"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">display<wbr/>OriginY</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
Do not change this value. It has no effect other than to break things.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.displayOriginY</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16705</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="displayWidth"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>display<wbr/>Width</span><ahref="#displayWidth"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">display<wbr/>Width</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The displayed width of this Game Object.</p>
<p>This value takes into account the scale factor.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.displayWidth</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17185</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="exclusive"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>exclusive</span><ahref="#exclusive"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">exclusive</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Does this Container exclusively manage its children?</p>
<p>The default is <code>true</code> which means a child added to this Container cannot
belong in another Container, which includes the Scene display list.</p>
<p>If you disable this then this Container will no longer exclusively manage its children.
This allows you to create all kinds of interesting graphical effects, such as replicating
Game Objects without reparenting them all over the Scene.
However, doing so will prevent children from receiving any kind of input event or have
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.exclusive</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16620</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="first"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>first</span><ahref="#first"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">first</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GameObject</span></div><divclass="tsd-comment tsd-typography"><p>Returns the first Game Object within the Container, or <code>null</code> if it is empty.</p>
<p>You can move the cursor by calling <code>Container.next</code> and <code>Container.previous</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.first</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17057</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="hasPostPipeline"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>has<wbr/>Post<wbr/>Pipeline</span><ahref="#hasPostPipeline"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">has<wbr/>Post<wbr/>Pipeline</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Does this Game Object have any Post Pipelines set?</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.hasPostPipeline</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17313</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="hasTransformComponent"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>has<wbr/>Transform<wbr/>Component</span><ahref="#hasTransformComponent"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">has<wbr/>Transform<wbr/>Component</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>A property indicating that a Game Object has this component.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.hasTransformComponent</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17453</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="height"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>height</span><ahref="#height"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">height</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The native (un-scaled) height of this Game Object.</p>
<p>Changing this value will not change the size that the Game Object is rendered in-game.
For that you need to either set the scale of the Game Object (<code>setScale</code>) or use
the <code>displayHeight</code> property.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.height</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17176</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="ignoreDestroy"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>ignore<wbr/>Destroy</span><ahref="#ignoreDestroy"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">ignore<wbr/>Destroy</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>This Game Object will ignore all calls made to its destroy method if this flag is set to <code>true</code>.
This includes calls that may come from a Group, Container or the Scene itself.
While it allows you to persist a Game Object across Scenes, please understand you are entirely
responsible for managing references to and from this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.ignoreDestroy</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19645</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="input"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>input</span><ahref="#input"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">input</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">InteractiveObject</span></div><divclass="tsd-comment tsd-typography"><p>If this Game Object is enabled for input then this property will contain an InteractiveObject instance.
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.input</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19632</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="key"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>key</span><ahref="#key"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">key</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8ce5de6d454da6159bfbabb55ec5e85bd293597a/src/ui/char-sprite.ts#L8">src/ui/char-sprite.ts:8</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="last"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>last</span><ahref="#last"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">last</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GameObject</span></div><divclass="tsd-comment tsd-typography"><p>Returns the last Game Object within the Container, or <code>null</code> if it is empty.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.last</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17064</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="length"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>length</span><ahref="#length"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">length</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The number of Game Objects inside this Container.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.length</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17050</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="list"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>list</span><ahref="#list"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">list</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">GameObject</span><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>An array holding the children of this Container.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.list</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16605</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="localTransform"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>local<wbr/>Transform</span><ahref="#localTransform"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">local<wbr/>Transform</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">TransformMatrix</span></div><divclass="tsd-comment tsd-typography"><p>Internal Transform Matrix used for local space conversion.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.localTransform</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16637</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="mask"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>mask</span><ahref="#mask"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">mask</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">BitmapMask</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GeometryMask</span></div><divclass="tsd-comment tsd-typography"><p>The Mask this Game Object is using during render.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.mask</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17250</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="maxSize"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>max<wbr/>Size</span><ahref="#maxSize"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">max<wbr/>Size</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>Containers can have an optional maximum size. If set to anything above 0 it
will constrict the addition of new Game Objects into the Container, capping off
the maximum limit the Container can grow in size to.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.maxSize</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16627</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="name"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>name</span><ahref="#name"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">name</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>The name of this Game Object.
Empty by default and never populated by Phaser, this is left for developers to use.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.name</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19592</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="next"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>next</span><ahref="#next"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">next</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GameObject</span></div><divclass="tsd-comment tsd-typography"><p>Returns the next Game Object within the Container, or <code>null</code> if it is empty.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.next</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17071</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="originX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>originX</span><ahref="#originX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">originX</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.originX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16687</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="originY"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>originY</span><ahref="#originY"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">originY</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
Do not change this value. It has no effect other than to break things.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.originY</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16693</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="parentContainer"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>parent<wbr/>Container</span><ahref="#parentContainer"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">parent<wbr/>Container</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Container</span></div><divclass="tsd-comment tsd-typography"><p>The parent Container of this Game Object, if it has one.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.parentContainer</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19586</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="position"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>position</span><ahref="#position"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">position</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The cursor position.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.position</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16632</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="postFX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>postFX</span><ahref="#postFX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">postFX</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">FX</span></div><divclass="tsd-comment tsd-typography"><p>The Post FX component of this Game Object.</p>
<p>This component allows you to apply a variety of built-in effects to this Game Object, such
as glow, blur, bloom, displacements, vignettes and more. You access them via this property,
<p>All FX are WebGL only and do not have Canvas counterparts.</p>
<p>Please see the FX Class for more details and available methods.</p>
<p>This property is always <code>null</code> until the <code>initPostPipeline</code> method is called.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.postFX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17375</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="postPipelineData"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>post<wbr/>Pipeline<wbr/>Data</span><ahref="#postPipelineData"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">post<wbr/>Pipeline<wbr/>Data</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">object</span></div><divclass="tsd-comment tsd-typography"><p>An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.postPipelineData</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17328</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="postPipelines"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>post<wbr/>Pipelines</span><ahref="#postPipelines"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">post<wbr/>Pipelines</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">PostFXPipeline</span><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>The WebGL Post FX Pipelines this Game Object uses for post-render effects.</p>
<p>The pipelines are processed in the order in which they appear in this array.</p>
<p>If you modify this array directly, be sure to set the
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.postPipelines</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17323</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="preFX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>preFX</span><ahref="#preFX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">preFX</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">FX</span></div><divclass="tsd-comment tsd-typography"><p>The Pre FX component of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.preFX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17355</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="previous"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>previous</span><ahref="#previous"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">previous</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GameObject</span></div><divclass="tsd-comment tsd-typography"><p>Returns the previous Game Object within the Container, or <code>null</code> if it is empty.</p>
<p>You can move the cursor by calling <code>Container.next</code> and <code>Container.previous</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.previous</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17078</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="renderFlags"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>render<wbr/>Flags</span><ahref="#renderFlags"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">render<wbr/>Flags</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The flags that are compared against <code>RENDER_MASK</code> to determine if this Game Object will render or not.
The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.
If those components are not used by your custom class then you can use this bitmask as you wish.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.renderFlags</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19619</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="rotation"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>rotation</span><ahref="#rotation"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">rotation</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The angle of this Game Object in radians.</p>
<p>Phaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left
and -PI/2 is up.</p>
<p>If you prefer to work in degrees, see the <code>angle</code> property instead.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.rotation</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17515</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scale"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scale</span><ahref="#scale"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scale</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object
to the same value, at the same time. When reading this value the result returned is <code>(scaleX + scaleY) / 2</code>.</p>
<p>Use of this property implies you wish the horizontal and vertical scales to be equal to each other. If this
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.scale</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17485</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scaleX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scaleX</span><ahref="#scaleX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scaleX</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The horizontal scale of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.scaleX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17490</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scaleY"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scaleY</span><ahref="#scaleY"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scaleY</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The vertical scale of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.scaleY</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17495</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scene"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scene</span><ahref="#scene"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scene</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Scene</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the Scene to which this Game Object belongs.</p>
<p>Game Objects can only belong to one Scene.</p>
<p>You should consider this property as being read-only. You cannot move a
Game Object to another Scene by simply changing it.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.scene</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19554</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scrollFactorX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scroll<wbr/>FactorX</span><ahref="#scrollFactorX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scroll<wbr/>FactorX</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The horizontal scroll factor of this Container.</p>
<p>The scroll factor controls the influence of the movement of a Camera upon this Container.</p>
<p>When a camera scrolls it will change the location at which this Container is rendered on-screen.
It does not change the Containers actual position values.</p>
<p>For a Container, setting this value will only update the Container itself, not its children.
If you wish to change the scrollFactor of the children as well, use the <code>setScrollFactor</code> method.</p>
<p>A value of 1 means it will move exactly in sync with a camera.
A value of 0 means it will not move at all, even if the camera moves.
Other values control the degree to which the camera movement is mapped to this Container.</p>
<p>Please be aware that scroll factor values other than 1 are not taken in to consideration when
calculating physics collisions. Bodies always collide based on their world position, but changing
the scroll factor is a visual adjustment to where the textures are rendered, which can offset
them from physics bodies if not accounted for in your code.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.scrollFactorX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16659</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scrollFactorY"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scroll<wbr/>FactorY</span><ahref="#scrollFactorY"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scroll<wbr/>FactorY</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The vertical scroll factor of this Container.</p>
<p>The scroll factor controls the influence of the movement of a Camera upon this Container.</p>
<p>When a camera scrolls it will change the location at which this Container is rendered on-screen.
It does not change the Containers actual position values.</p>
<p>For a Container, setting this value will only update the Container itself, not its children.
If you wish to change the scrollFactor of the children as well, use the <code>setScrollFactor</code> method.</p>
<p>A value of 1 means it will move exactly in sync with a camera.
A value of 0 means it will not move at all, even if the camera moves.
Other values control the degree to which the camera movement is mapped to this Container.</p>
<p>Please be aware that scroll factor values other than 1 are not taken in to consideration when
calculating physics collisions. Bodies always collide based on their world position, but changing
the scroll factor is a visual adjustment to where the textures are rendered, which can offset
them from physics bodies if not accounted for in your code.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.scrollFactorY</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16681</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="shown"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>shown</span><ahref="#shown"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">shown</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8ce5de6d454da6159bfbabb55ec5e85bd293597a/src/ui/char-sprite.ts#L10">src/ui/char-sprite.ts:10</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="state"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>state</span><ahref="#state"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">state</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The current state of this Game Object.</p>
in your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.
If you need to store complex data about your Game Object, look at using the Data Component instead.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.state</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19581</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="tabIndex"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>tab<wbr/>Index</span><ahref="#tabIndex"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">tab<wbr/>Index</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The Tab Index of the Game Object.
Reserved for future use by plugins and the Input Manager.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.tabIndex</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19605</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="type"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>type</span><ahref="#type"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">type</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>A textual representation of this Game Object, i.e. <code>sprite</code>.
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.type</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19569</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="variant"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>variant</span><ahref="#variant"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">variant</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8ce5de6d454da6159bfbabb55ec5e85bd293597a/src/ui/char-sprite.ts#L9">src/ui/char-sprite.ts:9</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="visible"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>visible</span><ahref="#visible"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">visible</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>The visible state of the Game Object.</p>
<p>An invisible Game Object will skip rendering, but will still process update logic.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.visible</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17634</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="w"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>w</span><ahref="#w"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">w</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The w position of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.w</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17476</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="width"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>width</span><ahref="#width"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">width</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The native (un-scaled) width of this Game Object.</p>
<p>Changing this value will not change the size that the Game Object is rendered in-game.
For that you need to either set the scale of the Game Object (<code>setScale</code>) or use
the <code>displayWidth</code> property.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.width</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17167</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="x"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>x</span><ahref="#x"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">x</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The x position of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.x</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17458</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="y"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>y</span><ahref="#y"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">y</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The y position of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.y</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17463</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="z"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>z</span><ahref="#z"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">z</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The z position of this Game Object.</p>
<p>Note: The z position does not control the rendering order of 2D Game Objects. Use
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.z</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17471</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="RENDER_MASK"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Static</code><codeclass="tsd-tag">Readonly</code><span>RENDER_<wbr/>MASK</span><ahref="#RENDER_MASK"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">RENDER_<wbr/>MASK</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The bitmask that <code>GameObject.renderFlags</code> is compared against to determine if the Game Object will render or not.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.RENDER_MASK</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19949</li></ul></aside></section></section></details><detailsclass="tsd-panel-group tsd-member-group tsd-accordion"open><summaryclass="tsd-accordion-summary"data-key="section-Methods"><h2><svgwidth="20"height="20"viewBox="0 0 24 24"fill="none"><usehref="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="add"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add</span><ahref="#add"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="add.add-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#add.add-1.T">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#add.add-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds the given Game Object, or array of Game Objects, to this Container.</p>
<p>Each Game Object must be unique within the Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="add.add-1.T"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#add.add-1.T">T</a><spanclass="tsd-signature-symbol"> | </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#add.add-1.T">T</a><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The Game Object, or array of Game Objects, to add to the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.add</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16760</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="addAt"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add<wbr/>At</span><ahref="#addAt"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="addAt.addAt-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add<wbr/>At</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#addAt.addAt-1.T-1">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span>, <spanclass="tsd-kind-parameter">index</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#addAt.addAt-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds the given Game Object, or array of Game Objects, to this Container at the specified position.</p>
<p>Existing Game Objects in the Container are shifted up.</p>
<p>Each Game Object must be unique within the Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="addAt.addAt-1.T-1"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#addAt.addAt-1.T-1">T</a><spanclass="tsd-signature-symbol"> | </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#addAt.addAt-1.T-1">T</a><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The Game Object, or array of Game Objects, to add to the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">index</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The position to insert the Game Object/s at. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.addAt</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16771</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="addListener"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add<wbr/>Listener</span><ahref="#addListener"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="addListener.addListener-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add<wbr/>Listener</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-kind-parameter">fn</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#addListener.addListener-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add a listener for a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.addListener</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9951</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="addToDisplayList"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add<wbr/>To<wbr/>Display<wbr/>List</span><ahref="#addToDisplayList"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="addToDisplayList.addToDisplayList-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add<wbr/>To<wbr/>Display<wbr/>List</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">displayList</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#addToDisplayList.addToDisplayList-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds this Game Object to the given Display List.</p>
<p>If no Display List is specified, it will default to the Display List owned by the Scene to which
this Game Object belongs.</p>
<p>A Game Object can only exist on one Display List at any given time, but may move freely between them.</p>
<p>If this Game Object is already on another Display List when this method is called, it will first
be removed from it, before being added to the new list.</p>
<p>You can query which list it is on by looking at the <code>Phaser.GameObjects.GameObject#displayList</code> property.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">displayList</span>: <spanclass="tsd-signature-type">Layer</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">DisplayList</span></span><divclass="tsd-comment tsd-typography"><p>The Display List to add to. Defaults to the Scene Display List.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.addToDisplayList</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19891</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="addToUpdateList"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add<wbr/>To<wbr/>Update<wbr/>List</span><ahref="#addToUpdateList"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="addToUpdateList.addToUpdateList-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add<wbr/>To<wbr/>Update<wbr/>List</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#addToUpdateList.addToUpdateList-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds this Game Object to the Update List belonging to the Scene.</p>
<p>When a Game Object is added to the Update List it will have its <code>preUpdate</code> method called
every game frame. This method is passed two parameters: <code>delta</code> and <code>time</code>.</p>
<p>If you wish to run your own logic within <code>preUpdate</code> then you should always call
<code>super.preUpdate(delta, time)</code> within it, or it may fail to process required operations,
such as Sprite animations.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.addToUpdateList</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19903</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="addedToScene"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>added<wbr/>To<wbr/>Scene</span><ahref="#addedToScene"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="addedToScene.addedToScene-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">added<wbr/>To<wbr/>Scene</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#addedToScene.addedToScene-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>This callback is invoked when this Game Object is added to a Scene.</p>
<p>Can be overriden by custom Game Objects, but be aware of some Game Objects that
will use this, such as Sprites, to add themselves into the Update List.</p>
<p>You can also listen for the <code>ADDED_TO_SCENE</code> event from this Game Object.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.addedToScene</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19834</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="bringToTop"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>bring<wbr/>To<wbr/>Top</span><ahref="#bringToTop"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="bringToTop.bringToTop-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">bring<wbr/>To<wbr/>Top</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#bringToTop.bringToTop-1.T-2">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#bringToTop.bringToTop-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Brings the given Game Object to the top of this Container.
This will cause it to render on-top of any other objects in the Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="bringToTop.bringToTop-1.T-2"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#bringToTop.bringToTop-1.T-2">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to bring to the top of the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.bringToTop</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16939</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="clearAlpha"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clear<wbr/>Alpha</span><ahref="#clearAlpha"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="clearAlpha.clearAlpha-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clear<wbr/>Alpha</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#clearAlpha.clearAlpha-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Clears all alpha values associated with this Game Object.</p>
<p>Immediately sets the alpha levels back to 1 (fully opaque).</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.clearAlpha</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17095</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="clearFX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clearFX</span><ahref="#clearFX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="clearFX.clearFX-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clearFX</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#clearFX.clearFX-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes all Pre and Post FX Controllers from this Game Object.</p>
<p>If you wish to remove a single controller, use the <code>preFX.remove(fx)</code> or <code>postFX.remove(fx)</code> methods instead.</p>
<p>If you wish to clear a single controller, use the <code>preFX.clear()</code> or <code>postFX.clear()</code> methods instead.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.clearFX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17448</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="clearMask"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clear<wbr/>Mask</span><ahref="#clearMask"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="clearMask.clearMask-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clear<wbr/>Mask</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">destroyMask</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#clearMask.clearMask-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Clears the mask that this Game Object was using.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">destroyMask</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Destroy the mask before clearing it? Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.clearMask</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17273</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="copyPosition"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>copy<wbr/>Position</span><ahref="#copyPosition"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="copyPosition.copyPosition-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">copy<wbr/>Position</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">source</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#copyPosition.copyPosition-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Copies an object's coordinates to this Game Object's position.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">source</span>: <spanclass="tsd-signature-type">Vector2Like</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Vector3Like</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Vector4Like</span></span><divclass="tsd-comment tsd-typography"><p>An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.copyPosition</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17530</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="count"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>count</span><ahref="#count"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="count.count-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">count</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">property</span>, <spanclass="tsd-kind-parameter">value</span>, <spanclass="tsd-kind-parameter">startIndex</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">endIndex</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#count.count-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns the total number of Game Objects in this Container that have a property
<p>You can optionally limit the operation to the <code>startIndex</code> - <code>endIndex</code> range.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">property</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The property to check.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The value to check.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">startIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">endIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.count</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16856</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="createBitmapMask"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>create<wbr/>Bitmap<wbr/>Mask</span><ahref="#createBitmapMask"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="createBitmapMask.createBitmapMask-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">create<wbr/>Bitmap<wbr/>Mask</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#createBitmapMask.createBitmapMask-1.G">G</a><spanclass="tsd-signature-symbol">, </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#createBitmapMask.createBitmapMask-1.T-3">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">maskObject</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">x</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">y</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">texture</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">frame</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">BitmapMask</span><ahref="#createBitmapMask.createBitmapMask-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Creates and returns a Bitmap Mask. This mask can be used by any Game Object,
including this one, or a Dynamic Texture.</p>
<p>Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.</p>
<p>To create the mask you need to pass in a reference to a renderable Game Object.
A renderable Game Object is one that uses a texture to render with, such as an
Image, Sprite, Render Texture or BitmapText.</p>
<p>If you do not provide a renderable object, and this Game Object has a texture,
it will use itself as the object. This means you can call this method to create
a Bitmap Mask from any renderable texture-based Game Object.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="createBitmapMask.createBitmapMask-1.G"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">G</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li><li><span><aid="createBitmapMask.createBitmapMask-1.T-3"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">DynamicTexture</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">maskObject</span>: <spanclass="tsd-signature-type">GameObject</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">DynamicTexture</span></span><divclass="tsd-comment tsd-typography"><p>The Game Object or Dynamic Texture that will be used as the mask. If <code>null</code> it will generate an Image Game Object using the rest of the arguments.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">x</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>If creating a Game Object, the horizontal position in the world.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">y</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>If creating a Game Object, the vertical position in the world.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">texture</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Texture</span></span><divclass="tsd-comment tsd-typography"><p>If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">frame</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Frame</span></span><divclass="tsd-comment tsd-typography"><p>If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">BitmapMask</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.createBitmapMask</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17294</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="createGeometryMask"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>create<wbr/>Geometry<wbr/>Mask</span><ahref="#createGeometryMask"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="createGeometryMask.createGeometryMask-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">create<wbr/>Geometry<wbr/>Mask</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#createGeometryMask.createGeometryMask-1.G-1">G</a><spanclass="tsd-signature-symbol">, </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#createGeometryMask.createGeometryMask-1.S">S</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">graphics</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">GeometryMask</span><ahref="#createGeometryMask.createGeometryMask-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Creates and returns a Geometry Mask. This mask can be used by any Game Object,
including this one.</p>
<p>To create the mask you need to pass in a reference to a Graphics Game Object.</p>
<p>If you do not provide a graphics object, and this Game Object is an instance
of a Graphics object, then it will use itself to create the mask.</p>
<p>This means you can call this method to create a Geometry Mask from any Graphics Game Object.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="createGeometryMask.createGeometryMask-1.G-1"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">G</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">Graphics</span></span></li><li><span><aid="createGeometryMask.createGeometryMask-1.S"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">S</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">Shape</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">graphics</span>: <spanclass="tsd-signature-type">Graphics</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Shape</span></span><divclass="tsd-comment tsd-typography"><p>A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">GeometryMask</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.createGeometryMask</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17308</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="destroy"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>destroy</span><ahref="#destroy"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="destroy.destroy-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">destroy</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">fromScene</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#destroy.destroy-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Destroys this Game Object removing it from the Display List and Update List and
severing all ties to parent resources.</p>
<p>Also removes itself from the Input Manager and Physics Manager if previously enabled.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">fromScene</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p><code>True</code> if this Game Object is being destroyed by the Scene, <code>false</code> if not. Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.destroy</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19944</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="disableInteractive"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>disable<wbr/>Interactive</span><ahref="#disableInteractive"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="disableInteractive.disableInteractive-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">disable<wbr/>Interactive</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#disableInteractive.disableInteractive-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>If this Game Object has previously been enabled for input, this will disable it.</p>
<p>An object that is disabled for input stops processing or being considered for
input events, but can be turned back on again at any time by simply calling
<code>setInteractive()</code> with no arguments provided.</p>
<p>If want to completely remove interaction from this Game Object then use <code>removeInteractive</code> instead.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.disableInteractive</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19802</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="each"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>each</span><ahref="#each"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="each.each-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">each</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">callback</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#each.each-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Passes all Game Objects in this Container to the given callback.</p>
<p>A copy of the Container is made before passing each entry to your callback.
This protects against the callback itself modifying the Container.</p>
<p>If you know for sure that the callback will not change the size of this Container
then you can use the more performant <code>Container.iterate</code> method instead.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">callback</span>: <spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>The function to call.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">object</span></span><divclass="tsd-comment tsd-typography"><p>Value to use as <code>this</code> when executing callback.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Rest</code><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Additional arguments that will be passed to the callback, after the child.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.each</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17012</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="emit"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>emit</span><ahref="#emit"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="emit.emit-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">emit</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#emit.emit-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Calls each of the listeners registered for a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Rest</code><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Additional arguments that will be passed to the event handler.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.emit</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9935</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="eventNames"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>event<wbr/>Names</span><ahref="#eventNames"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="eventNames.eventNames-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">event<wbr/>Names</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">symbol</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">[]</span><ahref="#eventNames.eventNames-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Return an array listing the events for which the emitter has registered listeners.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">symbol</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">[]</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.eventNames</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9916</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="exists"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>exists</span><ahref="#exists"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="exists.exists-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">exists</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#exists.exists-1.T-4">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#exists.exists-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns <code>true</code> if the given Game Object is a direct child of this Container.</p>
<p>This check does not scan nested Containers.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="exists.exists-1.T-4"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#exists.exists-1.T-4">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to check for within this Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.exists</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16985</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getAll"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>All</span><ahref="#getAll"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getAll.getAll-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>All</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#getAll.getAll-1.T-5">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">property</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">startIndex</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">endIndex</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getAll.getAll-1.T-5">T</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getAll.getAll-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns all Game Objects in this Container.</p>
<p>You can optionally specify a matching criteria using the <code>property</code> and <code>value</code> arguments.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="getAll.getAll-1.T-5"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">property</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The property to test on each Game Object in the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>If property is set then the <code>property</code> must strictly equal this value to be included in the results.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">startIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">endIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getAll.getAll-1.T-5">T</a><spanclass="tsd-signature-symbol">[]</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getAll</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16842</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getAt"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>At</span><ahref="#getAt"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getAt.getAt-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>At</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#getAt.getAt-1.T-6">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">index</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getAt.getAt-1.T-6">T</a><ahref="#getAt.getAt-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns the Game Object at the given position in this Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="getAt.getAt-1.T-6"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">index</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The position to get the Game Object from.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getAt.getAt-1.T-6">T</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getAt</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16777</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getBounds"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Bounds</span><ahref="#getBounds"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getBounds.getBounds-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Bounds</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">output</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Rectangle</span><ahref="#getBounds.getBounds-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Gets the bounds of this Container. It works by iterating all children of the Container,
getting their respective bounds, and then working out a min-max rectangle from that.
It does not factor in if the children render or not, all are included.</p>
<p>Some children are unable to return their bounds, such as Graphics objects, in which case
they are skipped.</p>
<p>Depending on the quantity of children in this Container it could be a really expensive call,
so cache it and only poll it as needed.</p>
<p>The values are stored and returned in a Rectangle object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">output</span>: <spanclass="tsd-signature-type">Rectangle</span></span><divclass="tsd-comment tsd-typography"><p>A Geom.Rectangle object to store the values in. If not provided a new Rectangle will be created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Rectangle</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getBounds</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16737</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getBoundsTransformMatrix"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Bounds<wbr/>Transform<wbr/>Matrix</span><ahref="#getBoundsTransformMatrix"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getBoundsTransformMatrix.getBoundsTransformMatrix-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Bounds<wbr/>Transform<wbr/>Matrix</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">TransformMatrix</span><ahref="#getBoundsTransformMatrix.getBoundsTransformMatrix-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns the world transform matrix as used for Bounds checks.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">TransformMatrix</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getBoundsTransformMatrix</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16752</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getByName"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>By<wbr/>Name</span><ahref="#getByName"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getByName.getByName-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>By<wbr/>Name</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#getByName.getByName-1.T-7">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">name</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getByName.getByName-1.T-7">T</a><ahref="#getByName.getByName-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Searches for the first instance of a child with its <code>name</code> property matching the given argument.
Should more than one child have the same name only the first is returned.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="getByName.getByName-1.T-7"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The name to search for.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getByName.getByName-1.T-7">T</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getByName</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16798</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getData"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Data</span><ahref="#getData"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getData.getData-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Data</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">any</span><ahref="#getData.getData-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.</p>
<p>This approach is useful for destructuring arrays in ES6.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key of the value to retrieve, or an array of keys.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">any</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getData</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19773</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getFirst"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>First</span><ahref="#getFirst"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getFirst.getFirst-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>First</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#getFirst.getFirst-1.T-8">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">property</span>, <spanclass="tsd-kind-parameter">value</span>, <spanclass="tsd-kind-parameter">startIndex</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">endIndex</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getFirst.getFirst-1.T-8">T</a><ahref="#getFirst.getFirst-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Gets the first Game Object in this Container.</p>
<p>You can also specify a property and value to search for, in which case it will return the first
Game Object in this Container with a matching property and / or value.</p>
<p>You can limit the search to the <code>startIndex</code> - <code>endIndex</code> range.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="getFirst.getFirst-1.T-8"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">property</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The property to test on each Game Object in the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The value to test the property against. Must pass a strict (<code>===</code>) comparison check.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">startIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">endIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getFirst.getFirst-1.T-8">T</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getFirst</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16821</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getIndex"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Index</span><ahref="#getIndex"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getIndex.getIndex-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Index</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#getIndex.getIndex-1.T-9">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#getIndex.getIndex-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns the index of the given Game Object in this Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="getIndex.getIndex-1.T-9"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getIndex.getIndex-1.T-9">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to search for in this Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getIndex</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16783</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getIndexList"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Index<wbr/>List</span><ahref="#getIndexList"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getIndexList.getIndexList-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Index<wbr/>List</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">[]</span><ahref="#getIndexList.getIndexList-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns an array containing the display list index of either this Game Object, or if it has one,
its parent Container. It then iterates up through all of the parent containers until it hits the
root of the display list (which is index 0 in the returned array).</p>
<p>Used internally by the InputPlugin but also useful if you wish to find out the display depth of
this Game Object and all of its ancestors.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">[]</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getIndexList</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19872</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getLocalPoint"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Local<wbr/>Point</span><ahref="#getLocalPoint"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getLocalPoint.getLocalPoint-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Local<wbr/>Point</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">x</span>, <spanclass="tsd-kind-parameter">y</span>, <spanclass="tsd-kind-parameter">point</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">camera</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Vector2</span><ahref="#getLocalPoint.getLocalPoint-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Takes the given <code>x</code> and <code>y</code> coordinates and converts them into local space for this
Game Object, taking into account parent and local transforms, and the Display Origin.</p>
<p>The returned Vector2 contains the translated point in its properties.</p>
<p>A Camera needs to be provided in order to handle modified scroll factors. If no
camera is specified, it will use the <code>main</code> camera from the Scene to which this
Game Object belongs.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">x</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The x position to translate.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">y</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The y position to translate.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">point</span>: <spanclass="tsd-signature-type">Vector2</span></span><divclass="tsd-comment tsd-typography"><p>A Vector2, or point-like object, to store the results in.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">camera</span>: <spanclass="tsd-signature-type">Camera</span></span><divclass="tsd-comment tsd-typography"><p>The Camera which is being tested against. If not given will use the Scene default camera.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Vector2</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getLocalPoint</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17620</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getLocalTransformMatrix"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Local<wbr/>Transform<wbr/>Matrix</span><ahref="#getLocalTransformMatrix"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getLocalTransformMatrix.getLocalTransformMatrix-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Local<wbr/>Transform<wbr/>Matrix</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">tempMatrix</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">TransformMatrix</span><ahref="#getLocalTransformMatrix.getLocalTransformMatrix-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Gets the local transform matrix for this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">tempMatrix</span>: <spanclass="tsd-signature-type">TransformMatrix</span></span><divclass="tsd-comment tsd-typography"><p>The matrix to populate with the values from this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">TransformMatrix</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getLocalTransformMatrix</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17597</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getParentRotation"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Parent<wbr/>Rotation</span><ahref="#getParentRotation"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getParentRotation.getParentRotation-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Parent<wbr/>Rotation</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#getParentRotation.getParentRotation-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Gets the sum total rotation of all of this Game Objects parent Containers.</p>
<p>The returned value is in radians and will be zero if this Game Object has no parent container.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getParentRotation</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17627</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getPostPipeline"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Post<wbr/>Pipeline</span><ahref="#getPostPipeline"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getPostPipeline.getPostPipeline-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Post<wbr/>Pipeline</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">pipeline</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">PostFXPipeline</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PostFXPipeline</span><spanclass="tsd-signature-symbol">[]</span><ahref="#getPostPipeline.getPostPipeline-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pipeline</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Function</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PostFXPipeline</span></span><divclass="tsd-comment tsd-typography"><p>The string-based name of the pipeline, or a pipeline class.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">PostFXPipeline</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PostFXPipeline</span><spanclass="tsd-signature-symbol">[]</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getPostPipeline</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17424</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getRandom"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Random</span><ahref="#getRandom"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getRandom.getRandom-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Random</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#getRandom.getRandom-1.T-10">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">startIndex</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">length</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getRandom.getRandom-1.T-10">T</a><ahref="#getRandom.getRandom-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns a random Game Object from this Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">length</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional length, the total number of elements (from the startIndex) to choose from.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#getRandom.getRandom-1.T-10">T</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getRandom</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16805</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="getWorldTransformMatrix"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>World<wbr/>Transform<wbr/>Matrix</span><ahref="#getWorldTransformMatrix"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="getWorldTransformMatrix.getWorldTransformMatrix-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>World<wbr/>Transform<wbr/>Matrix</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">tempMatrix</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">parentMatrix</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">TransformMatrix</span><ahref="#getWorldTransformMatrix.getWorldTransformMatrix-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Gets the world transform matrix for this Game Object, factoring in any parent Containers.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">tempMatrix</span>: <spanclass="tsd-signature-type">TransformMatrix</span></span><divclass="tsd-comment tsd-typography"><p>The matrix to populate with the values from this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">parentMatrix</span>: <spanclass="tsd-signature-type">TransformMatrix</span></span><divclass="tsd-comment tsd-typography"><p>A temporary matrix to hold parent values during the calculations.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">TransformMatrix</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.getWorldTransformMatrix</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17604</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="hide"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>hide</span><ahref="#hide"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="hide.hide-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">hide</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><ahref="#hide.hide-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8ce5de6d454da6159bfbabb55ec5e85bd293597a/src/ui/char-sprite.ts#L90">src/ui/char-sprite.ts:90</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="incData"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>inc<wbr/>Data</span><ahref="#incData"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="incData.incData-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">inc<wbr/>Data</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">amount</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#incData.incData-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.</p>
<p>When the value is first set, a <code>setdata</code> event is emitted from this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The key to change the value for.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">amount</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The amount to increase the given key by. Pass a negative value to decrease the key. Default 1.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.incData</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19734</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="initPostPipeline"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>init<wbr/>Post<wbr/>Pipeline</span><ahref="#initPostPipeline"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="initPostPipeline.initPostPipeline-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">init<wbr/>Post<wbr/>Pipeline</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">preFX</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#initPostPipeline.initPostPipeline-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>This should only be called during the instantiation of the Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">preFX</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Does this Game Object support Pre FX? Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.initPostPipeline</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17386</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="iterate"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>iterate</span><ahref="#iterate"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="iterate.iterate-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">iterate</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">callback</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#iterate.iterate-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Passes all Game Objects in this Container to the given callback.</p>
<p>Only use this method when you absolutely know that the Container will not be modified during
the iteration, i.e. by removing or adding to its contents.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">callback</span>: <spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>The function to call.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">object</span></span><divclass="tsd-comment tsd-typography"><p>Value to use as <code>this</code> when executing callback.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Rest</code><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Additional arguments that will be passed to the callback, after the child.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.iterate</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17023</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="listenerCount"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>listener<wbr/>Count</span><ahref="#listenerCount"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="listenerCount.listenerCount-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">listener<wbr/>Count</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#listenerCount.listenerCount-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Return the number of listeners listening to a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.listenerCount</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9928</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="listeners"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>listeners</span><ahref="#listeners"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="listeners.listeners-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">listeners</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Function</span><spanclass="tsd-signature-symbol">[]</span><ahref="#listeners.listeners-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Return the listeners registered for a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Function</span><spanclass="tsd-signature-symbol">[]</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.listeners</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9922</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="moveAbove"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>move<wbr/>Above</span><ahref="#moveAbove"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="moveAbove.moveAbove-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">move<wbr/>Above</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#moveAbove.moveAbove-1.T-11">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child1</span>, <spanclass="tsd-kind-parameter">child2</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#moveAbove.moveAbove-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Moves a Game Object above another one within this Container.</p>
<p>These 2 Game Objects must already be children of this Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="moveAbove.moveAbove-1.T-11"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child1</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#moveAbove.moveAbove-1.T-11">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to move above base Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">child2</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#moveAbove.moveAbove-1.T-11">T</a></span><divclass="tsd-comment tsd-typography"><p>The base Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.moveAbove</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16885</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="moveBelow"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>move<wbr/>Below</span><ahref="#moveBelow"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="moveBelow.moveBelow-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">move<wbr/>Below</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#moveBelow.moveBelow-1.T-12">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child1</span>, <spanclass="tsd-kind-parameter">child2</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#moveBelow.moveBelow-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Moves a Game Object below another one within this Container.</p>
<p>These 2 Game Objects must already be children of this Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="moveBelow.moveBelow-1.T-12"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child1</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#moveBelow.moveBelow-1.T-12">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to move below base Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">child2</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#moveBelow.moveBelow-1.T-12">T</a></span><divclass="tsd-comment tsd-typography"><p>The base Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.moveBelow</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16894</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="moveDown"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>move<wbr/>Down</span><ahref="#moveDown"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="moveDown.moveDown-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">move<wbr/>Down</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#moveDown.moveDown-1.T-13">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#moveDown.moveDown-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Moves the given Game Object down one place in this Container, unless it's already at the bottom.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="moveDown.moveDown-1.T-13"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#moveDown.moveDown-1.T-13">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to be moved in the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.moveDown</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16958</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="moveTo"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>move<wbr/>To</span><ahref="#moveTo"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="moveTo.moveTo-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">move<wbr/>To</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#moveTo.moveTo-1.T-14">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span>, <spanclass="tsd-kind-parameter">index</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#moveTo.moveTo-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Moves a Game Object to a new position within this Container.</p>
<p>The Game Object must already be a child of this Container.</p>
<p>The Game Object is removed from its old position and inserted into the new one.
Therefore the Container size does not change. Other children will change position accordingly.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="moveTo.moveTo-1.T-14"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#moveTo.moveTo-1.T-14">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to move.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">index</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The new position of the Game Object in this Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.moveTo</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16876</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="moveUp"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>move<wbr/>Up</span><ahref="#moveUp"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="moveUp.moveUp-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">move<wbr/>Up</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#moveUp.moveUp-1.T-15">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#moveUp.moveUp-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Moves the given Game Object up one place in this Container, unless it's already at the top.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="moveUp.moveUp-1.T-15"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#moveUp.moveUp-1.T-15">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to be moved in the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.moveUp</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16952</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="off"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>off</span><ahref="#off"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="off.off-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">off</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-kind-parameter">fn</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">once</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#off.off-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Remove the listeners of a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">fn</span>: <spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that match this function.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that have this context.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.off</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9977</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="on"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>on</span><ahref="#on"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="on.on-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">on</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-kind-parameter">fn</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#on.on-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add a listener for a given event.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.onChildDestroyed</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17088</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="once"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>once</span><ahref="#once"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="once.once-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">once</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-kind-parameter">fn</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#once.once-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add a one-time listener for a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.once</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9959</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="pointToContainer"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>point<wbr/>To<wbr/>Container</span><ahref="#pointToContainer"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="pointToContainer.pointToContainer-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">point<wbr/>To<wbr/>Container</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">source</span>, <spanclass="tsd-kind-parameter">output</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Vector2Like</span><ahref="#pointToContainer.pointToContainer-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Takes a Point-like object, such as a Vector2, Geom.Point or object with public x and y properties,
and transforms it into the space of this Container, then returns it in the output object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">source</span>: <spanclass="tsd-signature-type">Vector2Like</span></span><divclass="tsd-comment tsd-typography"><p>The Source Point to be transformed.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">output</span>: <spanclass="tsd-signature-type">Vector2Like</span></span><divclass="tsd-comment tsd-typography"><p>A destination object to store the transformed point in. If none given a Vector2 will be created and returned.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Vector2Like</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.pointToContainer</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16745</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><aid="preDestroy"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Protected</code><span>pre<wbr/>Destroy</span><ahref="#preDestroy"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="preDestroy.preDestroy-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">pre<wbr/>Destroy</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#preDestroy.preDestroy-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Internal destroy handler, called as part of the destroy process.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.preDestroy</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17083</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="remove"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove</span><ahref="#remove"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="remove.remove-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#remove.remove-1.T-16">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span>, <spanclass="tsd-kind-parameter">destroyChild</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#remove.remove-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes the given Game Object, or array of Game Objects, from this Container.</p>
<p>The Game Objects must already be children of this Container.</p>
<p>You can also optionally call <code>destroy</code> on each Game Object that is removed from the Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="remove.remove-1.T-16"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#remove.remove-1.T-16">T</a><spanclass="tsd-signature-symbol"> | </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#remove.remove-1.T-16">T</a><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The Game Object, or array of Game Objects, to be removed from the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">destroyChild</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on each child successfully removed from this Container. Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.remove</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16905</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeAll"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>All</span><ahref="#removeAll"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeAll.removeAll-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>All</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">destroyChild</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeAll.removeAll-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes all Game Objects from this Container.</p>
<p>You can also optionally call <code>destroy</code> on each Game Object that is removed from the Container.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">destroyChild</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on each Game Object successfully removed from this Container. Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeAll</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16932</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeAllListeners"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><ahref="#removeAllListeners"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeAllListeners.removeAllListeners-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeAllListeners.removeAllListeners-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Remove all listeners, or those of the specified event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeAllListeners</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9983</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeAt"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>At</span><ahref="#removeAt"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeAt.removeAt-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>At</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">index</span>, <spanclass="tsd-kind-parameter">destroyChild</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeAt.removeAt-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes the Game Object at the given position in this Container.</p>
<p>You can also optionally call <code>destroy</code> on the Game Object, if one is found.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">index</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The index of the Game Object to be removed.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">destroyChild</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on the Game Object if successfully removed from this Container. Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeAt</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16914</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeBetween"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>Between</span><ahref="#removeBetween"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeBetween.removeBetween-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>Between</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">startIndex</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">endIndex</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">destroyChild</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeBetween.removeBetween-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes the Game Objects between the given positions in this Container.</p>
<p>You can also optionally call <code>destroy</code> on each Game Object that is removed from the Container.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">startIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">endIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">destroyChild</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on each Game Object successfully removed from this Container. Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeBetween</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16924</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeFromDisplayList"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>From<wbr/>Display<wbr/>List</span><ahref="#removeFromDisplayList"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeFromDisplayList.removeFromDisplayList-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>From<wbr/>Display<wbr/>List</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeFromDisplayList.removeFromDisplayList-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes this Game Object from the Display List it is currently on.</p>
<p>A Game Object can only exist on one Display List at any given time, but may move freely removed
and added back at a later stage.</p>
<p>You can query which list it is on by looking at the <code>Phaser.GameObjects.GameObject#displayList</code> property.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeFromDisplayList</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19916</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeFromUpdateList"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>From<wbr/>Update<wbr/>List</span><ahref="#removeFromUpdateList"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeFromUpdateList.removeFromUpdateList-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>From<wbr/>Update<wbr/>List</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeFromUpdateList.removeFromUpdateList-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes this Game Object from the Scene's Update List.</p>
<p>When a Game Object is on the Update List, it will have its <code>preUpdate</code> method called
every game frame. Calling this method will remove it from the list, preventing this.</p>
<p>Removing a Game Object from the Update List will stop most internal functions working.
For example, removing a Sprite from the Update List will prevent it from being able to
run animations.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeFromUpdateList</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19928</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeInteractive"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>Interactive</span><ahref="#removeInteractive"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeInteractive.removeInteractive-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>Interactive</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeInteractive.removeInteractive-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>If this Game Object has previously been enabled for input, this will queue it
for removal, causing it to no longer be interactive. The removal happens on
the next game step, it is not immediate.</p>
<p>The Interactive Object that was assigned to this Game Object will be destroyed,
removed from the Input Manager and cleared from this Game Object.</p>
<p>If you wish to re-enable this Game Object at a later date you will need to
re-create its InteractiveObject by calling <code>setInteractive</code> again.</p>
<p>If you wish to only temporarily stop an object from receiving input then use
<code>disableInteractive</code> instead, as that toggles the interactive state, where-as
interactive. Instead, access the hitarea object directly and resize the shape
being used. I.e.: <code>sprite.input.hitArea.setSize(width, height)</code> (assuming the
shape is a Rectangle, which it is by default.)</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeInteractive</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19824</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeListener"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>Listener</span><ahref="#removeListener"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeListener.removeListener-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>Listener</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-kind-parameter">fn</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">once</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeListener.removeListener-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Remove the listeners of a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">fn</span>: <spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that match this function.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that have this context.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removeListener</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9968</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removePostPipeline"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>Post<wbr/>Pipeline</span><ahref="#removePostPipeline"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removePostPipeline.removePostPipeline-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>Post<wbr/>Pipeline</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">pipeline</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removePostPipeline.removePostPipeline-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.</p>
<p>If you wish to remove all Post Pipelines use the <code>resetPostPipeline</code> method instead.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pipeline</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PostFXPipeline</span></span><divclass="tsd-comment tsd-typography"><p>The string-based name of the pipeline, or a pipeline class.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removePostPipeline</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17439</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removedFromScene"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>removed<wbr/>From<wbr/>Scene</span><ahref="#removedFromScene"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removedFromScene.removedFromScene-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">removed<wbr/>From<wbr/>Scene</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#removedFromScene.removedFromScene-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>This callback is invoked when this Game Object is removed from a Scene.</p>
<p>Can be overriden by custom Game Objects, but be aware of some Game Objects that
will use this, such as Sprites, to removed themselves from the Update List.</p>
<p>You can also listen for the <code>REMOVED_FROM_SCENE</code> event from this Game Object.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.removedFromScene</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19844</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="replace"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>replace</span><ahref="#replace"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="replace.replace-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">replace</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#replace.replace-1.T-17">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">oldChild</span>, <spanclass="tsd-kind-parameter">newChild</span>, <spanclass="tsd-kind-parameter">destroyChild</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#replace.replace-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Replaces a Game Object in this Container with the new Game Object.
The new Game Object cannot already be a child of this Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="replace.replace-1.T-17"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">oldChild</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#replace.replace-1.T-17">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object in this Container that will be replaced.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">newChild</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#replace.replace-1.T-17">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to be added to this Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">destroyChild</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on the Game Object if successfully removed from this Container. Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.replace</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16977</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="resetPostPipeline"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>reset<wbr/>Post<wbr/>Pipeline</span><ahref="#resetPostPipeline"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="resetPostPipeline.resetPostPipeline-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">reset<wbr/>Post<wbr/>Pipeline</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">resetData</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#resetPostPipeline.resetPostPipeline-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Resets the WebGL Post Pipelines of this Game Object. It does this by calling
the <code>destroy</code> method on each post pipeline and then clearing the local array.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">resetData</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Reset the <code>postPipelineData</code> object to being an empty object? Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.resetPostPipeline</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17431</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="reverse"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>reverse</span><ahref="#reverse"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="reverse.reverse-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">reverse</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#reverse.reverse-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Reverses the order of all Game Objects in this Container.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.reverse</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16963</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="sendToBack"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>send<wbr/>To<wbr/>Back</span><ahref="#sendToBack"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="sendToBack.sendToBack-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">send<wbr/>To<wbr/>Back</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#sendToBack.sendToBack-1.T-18">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#sendToBack.sendToBack-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sends the given Game Object to the bottom of this Container.
This will cause it to render below any other objects in the Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="sendToBack.sendToBack-1.T-18"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#sendToBack.sendToBack-1.T-18">T</a></span><divclass="tsd-comment tsd-typography"><p>The Game Object to send to the bottom of the Container.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.sendToBack</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16946</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setActive"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Active</span><ahref="#setActive"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setActive.setActive-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Active</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setActive.setActive-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the <code>active</code> property of this Game Object and returns this Game Object for further chaining.
A Game Object with its <code>active</code> property set to <code>true</code> will be updated by the Scenes UpdateList.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>True if this Game Object should be set as active, false if not.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setActive</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19652</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setAll"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>All</span><ahref="#setAll"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setAll.setAll-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>All</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">property</span>, <spanclass="tsd-kind-parameter">value</span>, <spanclass="tsd-kind-parameter">startIndex</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">endIndex</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setAll.setAll-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the property to the given value on all Game Objects in this Container.</p>
<p>Optionally you can specify a start and end index. For example if this Container had 100 Game Objects,
and you set <code>startIndex</code> to 0 and <code>endIndex</code> to 50, it would return matches from only
the first 50 Game Objects.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">property</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The property that must exist on the Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The value to get the property to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">startIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">endIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setAll</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16998</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setAlpha"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Alpha</span><ahref="#setAlpha"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setAlpha.setAlpha-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Alpha</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setAlpha.setAlpha-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.
Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The alpha value applied across the whole Game Object. Default 1.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setAlpha</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17102</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setAngle"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Angle</span><ahref="#setAngle"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setAngle.setAngle-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Angle</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">degrees</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setAngle.setAngle-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the angle of this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">degrees</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The rotation of this Game Object, in degrees. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setAngle</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17557</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setBlendMode"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Blend<wbr/>Mode</span><ahref="#setBlendMode"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setBlendMode.setBlendMode-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Blend<wbr/>Mode</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setBlendMode.setBlendMode-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the Blend Mode being used by this Game Object.</p>
<p>This can be a const, such as <code>Phaser.BlendModes.SCREEN</code>, or an integer, such as 4 (for Overlay)</p>
<p>Under WebGL only the following Blend Modes are available:</p>
<ul>
<li>NORMAL</li>
<li>ADD</li>
<li>MULTIPLY</li>
<li>SCREEN</li>
<li>ERASE (only works when rendering to a framebuffer, like a Render Texture)</li>
</ul>
<p>Canvas has more available depending on browser support.</p>
<p>You can also create your own custom Blend Modes in WebGL.</p>
<p>Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending
on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
reasons try to be careful about the construction of your Scene and the frequency in which blend modes
are used.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">BlendModes</span></span><divclass="tsd-comment tsd-typography"><p>The BlendMode value. Either a string, a CONST or a number.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setBlendMode</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17158</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setData"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Data</span><ahref="#setData"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setData.setData-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Data</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#setData.setData-1.T-19">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">data</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setData.setData-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Allows you to store a key value pair within this Game Objects Data Manager.</p>
<p>If the Game Object has not been enabled for data (via <code>setDataEnabled</code>) then it will be enabled
<p>When the value is first set, a <code>setdata</code> event is emitted from this Game Object.</p>
<p>If the key already exists, a <code>changedata</code> event is emitted instead, along an event named after the key.
For example, if you updated an existing key called <code>PlayerLives</code> then it would emit the event <code>changedata-PlayerLives</code>.
These events will be emitted regardless if you use this method to set the value, or the direct <code>values</code> setter.</p>
<p>Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings.
This means the keys <code>gold</code> and <code>Gold</code> are treated as two unique values within the Data Manager.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="setData.setData-1.T-19"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">unknown</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#setData.setData-1.T-19">T</a></span><divclass="tsd-comment tsd-typography"><p>The key to set the value for. Or an object of key value pairs. If an object the <code>data</code> argument is ignored.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">data</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The value to set for the given key. If an object is provided as the key this argument is ignored.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setData</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19720</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setDataEnabled"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Data<wbr/>Enabled</span><ahref="#setDataEnabled"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setDataEnabled.setDataEnabled-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Data<wbr/>Enabled</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setDataEnabled.setDataEnabled-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Data Manager component to this Game Object.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setDataEnabled</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19677</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setDepth"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Depth</span><ahref="#setDepth"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setDepth.setDepth-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Depth</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setDepth.setDepth-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>The depth of this Game Object within the Scene.</p>
of Game Objects, without actually moving their position in the display list.</p>
<p>The default depth is zero. A Game Object with a higher depth
value will always render in front of one with a lower value.</p>
<p>Setting the depth will queue a depth sort event within the Scene.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The depth of this Game Object. Ensure this value is only ever a number data-type.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setDepth</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17245</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setDisplaySize"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Display<wbr/>Size</span><ahref="#setDisplaySize"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setDisplaySize.setDisplaySize-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Display<wbr/>Size</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">width</span>, <spanclass="tsd-kind-parameter">height</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setDisplaySize.setDisplaySize-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the display size of this Game Object.</p>
<p>Calling this will adjust the scale.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">width</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The width of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">height</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The height of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setDisplaySize</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17218</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setExclusive"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Exclusive</span><ahref="#setExclusive"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setExclusive.setExclusive-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Exclusive</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setExclusive.setExclusive-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Does this Container exclusively manage its children?</p>
<p>The default is <code>true</code> which means a child added to this Container cannot
belong in another Container, which includes the Scene display list.</p>
<p>If you disable this then this Container will no longer exclusively manage its children.
This allows you to create all kinds of interesting graphical effects, such as replicating
Game Objects without reparenting them all over the Scene.
However, doing so will prevent children from receiving any kind of input event or have
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>The exclusive state of this Container. Default true.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setExclusive</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16721</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setInteractive"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Interactive</span><ahref="#setInteractive"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setInteractive.setInteractive-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Interactive</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">hitArea</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">callback</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">dropZone</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setInteractive.setInteractive-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Pass this Game Object to the Input Manager to enable it for Input.</p>
<p>Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area
for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced
input detection.</p>
<p>If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">hitArea</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">callback</span>: <spanclass="tsd-signature-type">HitAreaCallback</span></span><divclass="tsd-comment tsd-typography"><p>The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">dropZone</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Should this Game Object be treated as a drop zone target? Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setInteractive</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19791</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setMask"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Mask</span><ahref="#setMask"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setMask.setMask-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Mask</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">mask</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setMask.setMask-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the mask that this Game Object will use to render with.</p>
<p>The mask must have been previously created and can be either a GeometryMask or a BitmapMask.
Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.</p>
<p>If a mask is already set on this Game Object it will be immediately replaced.</p>
<p>Masks are positioned in global space and are not relative to the Game Object to which they
are applied. The reason for this is that multiple Game Objects can all share the same mask.</p>
<p>Masks have no impact on physics or input detection. They are purely a rendering component
that allows you to limit what is visible during the render pass.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">mask</span>: <spanclass="tsd-signature-type">BitmapMask</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GeometryMask</span></span><divclass="tsd-comment tsd-typography"><p>The mask this Game Object will use when rendering.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setMask</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17267</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setName"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Name</span><ahref="#setName"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setName.setName-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Name</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setName.setName-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the <code>name</code> property of this Game Object and returns this Game Object for further chaining.
The <code>name</code> property is not populated by Phaser and is presented for your own use.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The name to be given to this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setName</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19659</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setPosition"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Position</span><ahref="#setPosition"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setPosition.setPosition-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Position</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">x</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">y</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">z</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">w</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setPosition.setPosition-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the position of this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">x</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The x position of this Game Object. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">y</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The y position of this Game Object. If not set it will use the <code>x</code> value. Default x.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">z</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The z position of this Game Object. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">w</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The w position of this Game Object. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setPosition</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17524</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="setPositionRelative"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Position<wbr/>Relative</span><ahref="#setPositionRelative"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="setPositionRelative.setPositionRelative-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Position<wbr/>Relative</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">guideObject</span>, <spanclass="tsd-kind-parameter">x</span>, <spanclass="tsd-kind-parameter">y</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setPositionRelative.setPositionRelative-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets this object's position relative to another object with a given offset</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">guideObject</span>: <spanclass="tsd-signature-type">any</span></span></li><li><span><spanclass="tsd-kind-parameter">x</span>: <spanclass="tsd-signature-type">number</span></span></li><li><span><spanclass="tsd-kind-parameter">y</span>: <spanclass="tsd-signature-type">number</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setPositionRelative</p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8ce5de6d454da6159bfbabb55ec5e85bd293597a/src/typings/phaser/index.d.ts#L23">src/typings/phaser/index.d.ts:23</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setPostPipeline"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Post<wbr/>Pipeline</span><ahref="#setPostPipeline"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setPostPipeline.setPostPipeline-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Post<wbr/>Pipeline</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">pipelines</span>, <spanclass="tsd-kind-parameter">pipelineData</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">copyData</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setPostPipeline.setPostPipeline-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets one, or more, Post Pipelines on this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pipelines</span>: <br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">string</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">Function</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">PostFXPipeline</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">PostFXPipeline</span><spanclass="tsd-signature-symbol">[]</span><br/><span></span><spanclass="tsd-signature-symbol">| </span><spanclass="tsd-signature-type">Function</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">pipelineData</span>: <spanclass="tsd-signature-type">object</span></span><divclass="tsd-comment tsd-typography"><p>Optional pipeline data object that is set in to the <code>postPipelineData</code> property of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">copyData</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Should the pipeline data object be <em>deep copied</em> into the <code>postPipelineData</code> property of this Game Object? If <code>false</code> it will be set by reference instead. Default true.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setPostPipeline</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17407</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setPostPipelineData"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Post<wbr/>Pipeline<wbr/>Data</span><ahref="#setPostPipelineData"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setPostPipelineData.setPostPipelineData-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Post<wbr/>Pipeline<wbr/>Data</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setPostPipelineData.setPostPipelineData-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an entry to the <code>postPipelineData</code> object belonging to this Game Object.</p>
<p>If <code>value</code> is undefined, and <code>key</code> exists, <code>key</code> is removed from the data object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The key of the pipeline data to set, update, or delete.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The value to be set with the key. If <code>undefined</code> then <code>key</code> will be deleted from the object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setPostPipelineData</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17418</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setRandomPosition"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Random<wbr/>Position</span><ahref="#setRandomPosition"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setRandomPosition.setRandomPosition-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Random<wbr/>Position</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">x</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">y</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">width</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">height</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setRandomPosition.setRandomPosition-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the position of this Game Object to be a random position within the confines of
the given area.</p>
<p>If no area is specified a random position between 0 x 0 and the game width x height is used instead.</p>
<p>The position does not factor in the size of this Game Object, meaning that only the origin is
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">x</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The x position of the top-left of the random area. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">y</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The y position of the top-left of the random area. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">width</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The width of the random area.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">height</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The height of the random area.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setRandomPosition</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17545</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setRotation"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Rotation</span><ahref="#setRotation"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setRotation.setRotation-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Rotation</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">radians</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setRotation.setRotation-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the rotation of this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">radians</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The rotation of this Game Object, in radians. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setRotation</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17551</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setScale"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Scale</span><ahref="#setScale"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setScale.setScale-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Scale</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">x</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">y</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setScale.setScale-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the scale of this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">x</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The horizontal scale of this Game Object. Default 1.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">y</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The vertical scale of this Game Object. If not set it will use the <code>x</code> value. Default x.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setScale</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17564</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setScrollFactor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Scroll<wbr/>Factor</span><ahref="#setScrollFactor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setScrollFactor.setScrollFactor-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Scroll<wbr/>Factor</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">x</span>, <spanclass="tsd-kind-parameter">y</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">updateChildren</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setScrollFactor.setScrollFactor-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the scroll factor of this Container and optionally all of its children.</p>
<p>The scroll factor controls the influence of the movement of a Camera upon this Game Object.</p>
<p>When a camera scrolls it will change the location at which this Game Object is rendered on-screen.
It does not change the Game Objects actual position values.</p>
<p>A value of 1 means it will move exactly in sync with a camera.
A value of 0 means it will not move at all, even if the camera moves.
Other values control the degree to which the camera movement is mapped to this Game Object.</p>
<p>Please be aware that scroll factor values other than 1 are not taken in to consideration when
calculating physics collisions. Bodies always collide based on their world position, but changing
the scroll factor is a visual adjustment to where the textures are rendered, which can offset
them from physics bodies if not accounted for in your code.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">x</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The horizontal scroll factor of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">y</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The vertical scroll factor of this Game Object. If not set it will use the <code>x</code> value. Default x.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">updateChildren</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Apply this scrollFactor to all Container children as well? Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setScrollFactor</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17045</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setSize"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Size</span><ahref="#setSize"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setSize.setSize-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Size</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">width</span>, <spanclass="tsd-kind-parameter">height</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setSize.setSize-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the internal size of this Game Object, as used for frame or physics body creation.</p>
<p>This will not change the size that the Game Object is rendered in-game.
For that you need to either set the scale of the Game Object (<code>setScale</code>) or call the
<code>setDisplaySize</code> method, which is the same thing as changing the scale but allows you
to do so by giving pixel values.</p>
<p>If you have enabled this Game Object for input, changing the size will <em>not</em> change the
size of the hit area. To do this you should adjust the <code>input.hitArea</code> object directly.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">width</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The width of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">height</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The height of this Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setSize</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17209</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setState"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>State</span><ahref="#setState"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setState.setState-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>State</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setState.setState-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the current state of this Game Object.</p>
<p>Phaser itself will never modify the State of a Game Object, although plugins may do so.</p>
The state value should typically be an integer (ideally mapped to a constant
in your game code), but could also be a string. It is recommended to keep it light and simple.
If you need to store complex data about your Game Object, look at using the Data Component instead.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The state of the Game Object.</p>
<p>An invisible Game Object will skip rendering, but will still process update logic.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>The visible state of the Game Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setVisible</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17642</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setW"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>setW</span><ahref="#setW"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setW.setW-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">setW</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setW.setW-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the w position of this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The w position of this Game Object. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setW</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17591</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setX"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>setX</span><ahref="#setX"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setX.setX-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">setX</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setX.setX-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the x position of this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The x position of this Game Object. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setX</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17570</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setY"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>setY</span><ahref="#setY"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setY.setY-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">setY</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setY.setY-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the y position of this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The y position of this Game Object. Default 0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.setY</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17576</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setZ"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>setZ</span><ahref="#setZ"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setZ.setZ-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">setZ</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setZ.setZ-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the z position of this Game Object.</p>
<p>Note: The z position does not control the rendering order of 2D Game Objects. Use
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The z position of this Game Object. Default 0.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.shuffle</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16968</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="shutdown"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>shutdown</span><ahref="#shutdown"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="shutdown.shutdown-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">shutdown</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#shutdown.shutdown-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes all listeners.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.shutdown</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9906</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="sort"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>sort</span><ahref="#sort"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="sort.sort-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">sort</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">property</span>, <spanclass="tsd-kind-parameter">handler</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#sort.sort-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sort the contents of this Container so the items are in order based on the given property.
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">handler</span>: <spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.sort</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16791</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="swap"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>swap</span><ahref="#swap"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="swap.swap-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">swap</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="ui_char_sprite.default.html#swap.swap-1.T-20">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child1</span>, <spanclass="tsd-kind-parameter">child2</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#swap.swap-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Swaps the position of two Game Objects in this Container.
Both Game Objects must belong to this Container.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="swap.swap-1.T-20"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><spanclass="tsd-signature-type">GameObject</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child1</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#swap.swap-1.T-20">T</a></span><divclass="tsd-comment tsd-typography"><p>The first Game Object to swap.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">child2</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="field_arena.ArenaBase.html#swap.swap-1.T-20">T</a></span><divclass="tsd-comment tsd-typography"><p>The second Game Object to swap.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.swap</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16864</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="toJSON"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>toJSON</span><ahref="#toJSON"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="toJSON.toJSON-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">toJSON</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">JSONGameObject</span><ahref="#toJSON.toJSON-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns a JSON representation of the Game Object.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">JSONGameObject</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.toJSON</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19855</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="toggleData"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>toggle<wbr/>Data</span><ahref="#toggleData"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="toggleData.toggleData-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">toggle<wbr/>Data</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#toggleData.toggleData-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.</p>
<p>When the value is first set, a <code>setdata</code> event is emitted from this Game Object.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The key to toggle the value for.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.toggleData</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19747</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="update"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>update</span><ahref="#update"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="update.update-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">update</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#update.update-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>To be overridden by custom GameObjects. Allows base objects to be used in a Pool.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.GameObjects.Container.update</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19850</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="willRender"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>will<wbr/>Render</span><ahref="#willRender"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="willRender.willRender-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">will<wbr/>Render</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">camera</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#willRender.willRender-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Compares the renderMask with the renderFlags to see if this Game Object will render or not.
Also checks the Game Object against the given Cameras exclusion list.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">camera</span>: <spanclass="tsd-signature-type">Camera</span></span><divclass="tsd-comment tsd-typography"><p>The Camera to check against this Game Object.</p>
