This repository was archived by the owner on Jun 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 101
Expand file tree
/
Copy pathAnimationDebug.html
More file actions
63 lines (63 loc) · 46.8 KB
/
AnimationDebug.html
File metadata and controls
63 lines (63 loc) · 46.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["types"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>AnimationDebug</title><meta name="description" content="DEBUG MODE"/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="./">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> AnimationDebug</h1><h4><small><a href="./">no package</a></small></h4><h4><small>extends <a class="type" title="flixel.FlxState - This is the basic game "state" object - e." href="./flixel/FlxState.html">FlxState</a> › <a class="type" title="flixel.group.FlxTypedGroup - This is an organizational class that can update and render a bunch of FlxBasics." href="./flixel/group/FlxTypedGroup.html">FlxTypedGroup</a> › <a class="type" title="flixel.FlxBasic - This is a useful "generic" Flixel object." href="./flixel/FlxBasic.html">FlxBasic</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span></div><div class="body"><div class="doc doc-main"><p>DEBUG MODE</p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ daOtherAnim : "bf", daAnim : "spooky" })</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">daAnim:<a class="type" title="String - The basic String class." href="./String.html">String</a> = "spooky",</span> <span style="white-space:nowrap">daOtherAnim:<a class="type" title="String - The basic String class." href="./String.html">String</a> = "bf"</span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.FlxState - This is the basic game "state" object - e." href="./flixel/FlxState.html">FlxState</a></h4><div style="display:none"><div class="field "><a name="bgColor"></a><h3 class="anchor"><code><a href="#bgColor"><span class="identifier">bgColor</span></a>:<a class="type" title="flixel.util.FlxColor - Class representing a color, based on Int." href="./flixel/util/FlxColor.html">FlxColor</a></code></h3><div class="doc"><p>The natural background color the cameras default to. In <code>AARRGGBB</code> format.</p></div></div><div class="field "><a name="destroySubStates"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(true)</span><a href="#destroySubStates"><span class="identifier">destroySubStates</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a><span> = true</span></code></h3><div class="doc"><p>If substates get destroyed when they are closed, setting this to
<code><a href="../Bool.html">false</a></code> might reduce state creation time, at greater memory cost.</p></div></div><div class="field "><a name="persistentDraw"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(true)</span><a href="#persistentDraw"><span class="identifier">persistentDraw</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a><span> = true</span></code></h3><div class="doc"><p>Determines whether or not this state is updated even when it is not the active state.
For example, if you have your game state first, and then you push a menu state on top of it,
if this is set to <code><a href="../Bool.html">true</a></code>, the game state would continue to be drawn behind the pause state.
By default this is <code><a href="../Bool.html">true</a></code>, so background states will continue to be drawn behind the current state.</p>
<p>If background states are not <code>visible</code> when you have a different state on top,
you should set this to <code><a href="../Bool.html">false</a></code> for improved performance.</p></div></div><div class="field "><a name="persistentUpdate"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(false)</span><a href="#persistentUpdate"><span class="identifier">persistentUpdate</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a><span> = false</span></code></h3><div class="doc"><p>Determines whether or not this state is updated even when it is not the active state.
For example, if you have your game state first, and then you push a menu state on top of it,
if this is set to <code><a href="../Bool.html">true</a></code>, the game state would continue to update in the background.
By default this is <code><a href="../Bool.html">false</a></code>, so background states will be "paused" when they are not active.</p></div></div><div class="field "><a name="subState"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#subState"><span class="identifier">subState</span></a>:<a class="type" title="flixel.FlxSubState - A FlxSubState can be opened inside of a FlxState." href="./flixel/FlxSubState.html">FlxSubState</a></code></h3><div class="doc"><p>Current substate. Substates also can be nested.</p></div></div><div class="field "><a name="subStateClosed"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#subStateClosed"><span class="identifier">subStateClosed</span></a>:<a class="type" title="flixel.util.FlxTypedSignal" href="./flixel/util/FlxTypedSignal.html">FlxTypedSignal</a><<a class="type" title="flixel.FlxSubState - A FlxSubState can be opened inside of a FlxState." href="./flixel/FlxSubState.html">FlxSubState</a> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>></code></h3><div class="doc"><p>A <code><a href="../flixel/util/FlxSignal.html#FlxSignal">FlxSignal</a></code> that dispatches when a sub state is closed from this state.</p><div class="javadoc inline-content">Available since <p>4.9.0</p>.</div></div></div><div class="field "><a name="subStateOpened"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#subStateOpened"><span class="identifier">subStateOpened</span></a>:<a class="type" title="flixel.util.FlxTypedSignal" href="./flixel/util/FlxTypedSignal.html">FlxTypedSignal</a><<a class="type" title="flixel.FlxSubState - A FlxSubState can be opened inside of a FlxState." href="./flixel/FlxSubState.html">FlxSubState</a> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>></code></h3><div class="doc"><p>A <code><a href="../flixel/util/FlxSignal.html#FlxSignal">FlxSignal</a></code> that dispatches when a sub state is opened from this state.</p><div class="javadoc inline-content">Available since <p>4.9.0</p>.</div></div></div></div><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.group.FlxTypedGroup - This is an organizational class that can update and render a bunch of FlxBasics." href="./flixel/group/FlxTypedGroup.html">FlxTypedGroup</a></h4><div style="display:none"><div class="field "><a name="length"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(0)</span><span class="label">read only</span><a href="#length"><span class="identifier">length</span></a>:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a><span> = 0</span></code></h3><div class="doc"><p>The number of entries in the members array. For performance and safety you should check this
variable instead of <code>members.length</code> unless you really know what you're doing!</p></div></div><div class="field "><a name="maxSize"></a><h3 class="anchor"><code><a href="#maxSize"><span class="identifier">maxSize</span></a>:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>The maximum capacity of this group. Default is <code>0</code>, meaning no max capacity, and the group can just grow.</p></div></div><div class="field "><a name="memberAdded"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#memberAdded"><span class="identifier">memberAdded</span></a>:<a class="type" title="flixel.util.FlxTypedSignal" href="./flixel/util/FlxTypedSignal.html">FlxTypedSignal</a><<span class="type">T</span> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>></code></h3><div class="doc"><p>A <code><a href="../../flixel/util/FlxSignal.html#FlxSignal">FlxSignal</a></code> that dispatches when a child is added to this group.</p><div class="javadoc inline-content">Available since <p>4.4.0</p>.</div></div></div><div class="field "><a name="memberRemoved"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#memberRemoved"><span class="identifier">memberRemoved</span></a>:<a class="type" title="flixel.util.FlxTypedSignal" href="./flixel/util/FlxTypedSignal.html">FlxTypedSignal</a><<span class="type">T</span> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>></code></h3><div class="doc"><p>A <code><a href="../../flixel/util/FlxSignal.html#FlxSignal">FlxSignal</a></code> that dispatches when a child is removed from this group.</p><div class="javadoc inline-content">Available since <p>4.4.0</p>.</div></div></div><div class="field "><a name="members"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#members"><span class="identifier">members</span></a>:<a class="type" title="Array" href="./Array.html">Array</a><<span class="type">T</span>></code></h3><div class="doc"><p><code><a href="../../Array.html">Array</a></code> of all the members in this group.</p></div></div></div><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.FlxBasic - This is a useful "generic" Flixel object." href="./flixel/FlxBasic.html">FlxBasic</a></h4><div style="display:none"><div class="field "><a name="ID"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(idEnumerator++)</span><a href="#ID"><span class="identifier">ID</span></a>:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a><span> = idEnumerator++</span></code></h3><div class="doc"><p>A unique ID starting from 0 and increasing by 1 for each subsequent <code><a href="../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> that is created.</p></div></div><div class="field "><a name="active"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(true)</span><a href="#active"><span class="identifier">active</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a><span> = true</span></code></h3><div class="doc"><p>Controls whether <code>update()</code> is automatically called by <code><a href="../flixel/FlxState.html#FlxState">FlxState</a></code>/<code><a href="../flixel/group/FlxGroup.html#FlxGroup">FlxGroup</a></code>.</p></div></div><div class="field "><a name="alive"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(true)</span><a href="#alive"><span class="identifier">alive</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a><span> = true</span></code></h3><div class="doc"><p>Useful state for many game objects - "dead" (<code>!alive</code>) vs <code>alive</code>. <code>kill()</code> and
<code>revive()</code> both flip this switch (along with <code>exists</code>, but you can override that).</p></div></div><div class="field "><a name="camera"></a><h3 class="anchor"><code><a href="#camera"><span class="identifier">camera</span></a>:<a class="type" title="flixel.FlxCamera - The camera class is used to display the game's visuals." href="./flixel/FlxCamera.html">FlxCamera</a></code></h3><div class="doc"><p>Gets ot sets the first camera of this object.</p></div></div><div class="field "><a name="cameras"></a><h3 class="anchor"><code><a href="#cameras"><span class="identifier">cameras</span></a>:<a class="type" title="Array" href="./Array.html">Array</a><<a class="type" title="flixel.FlxCamera - The camera class is used to display the game's visuals." href="./flixel/FlxCamera.html">FlxCamera</a>></code></h3><div class="doc"><p>This determines on which <code><a href="../flixel/FlxCamera.html#FlxCamera">FlxCamera</a></code>s this object will be drawn. If it is <code>null</code> / has not been
set, it uses the list of default draw targets, which is controlled via <code><a href="../flixel/FlxG.html#setDefaultDrawTarget">FlxG.camera.setDefaultDrawTarget</a></code>
as well as the <code>DefaultDrawTarget</code> argument of <code><a href="../flixel/FlxG.html#add">FlxG.camera.add</a></code>.</p></div></div><div class="field "><a name="exists"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(true)</span><a href="#exists"><span class="identifier">exists</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a><span> = true</span></code></h3><div class="doc"><p>Controls whether <code>update()</code> and <code>draw()</code> are automatically called by <code><a href="../flixel/FlxState.html#FlxState">FlxState</a></code>/<code><a href="../flixel/group/FlxGroup.html#FlxGroup">FlxGroup</a></code>.</p></div></div><div class="field "><a name="visible"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(true)</span><a href="#visible"><span class="identifier">visible</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a><span> = true</span></code></h3><div class="doc"><p>Controls whether <code>draw()</code> is automatically called by <code><a href="../flixel/FlxState.html#FlxState">FlxState</a></code>/<code><a href="../flixel/group/FlxGroup.html#FlxGroup">FlxGroup</a></code>.</p></div></div></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.FlxState - This is the basic game "state" object - e." href="./flixel/FlxState.html">FlxState</a></h4><div style="display:none"><div class="field "><a name="closeSubState"></a><h3 class="anchor"><code><a href="#closeSubState"><span class="identifier">closeSubState</span></a>():<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Closes the substate of this state, if one exists.</p></div></div><div class="field "><a name="onFocus"></a><h3 class="anchor"><code><a href="#onFocus"><span class="identifier">onFocus</span></a>():<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>This method is called after the game receives focus.
Can be useful for third party libraries, such as tweening engines.</p></div></div><div class="field "><a name="onFocusLost"></a><h3 class="anchor"><code><a href="#onFocusLost"><span class="identifier">onFocusLost</span></a>():<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>This method is called after the game loses focus.
Can be useful for third party libraries, such as tweening engines.</p></div></div><div class="field "><a name="onResize"></a><h3 class="anchor"><code><a href="#onResize"><span class="identifier">onResize</span></a>(<span style="white-space:nowrap">Width:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">Height:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>This function is called whenever the window size has been changed.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Width</code></th><td><p>The new window width</p></td></tr><tr><th style="width:25%;"><code>Height</code></th><td><p>The new window Height</p></td></tr></table></div></div><div class="field "><a name="openSubState"></a><h3 class="anchor"><code><a href="#openSubState"><span class="identifier">openSubState</span></a>(<span style="white-space:nowrap">SubState:<a class="type" title="flixel.FlxSubState - A FlxSubState can be opened inside of a FlxState." href="./flixel/FlxSubState.html">FlxSubState</a></span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="resetSubState"></a><h3 class="anchor"><code><a href="#resetSubState"><span class="identifier">resetSubState</span></a>():<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Load substate for this state</p></div></div><div class="field "><a name="switchTo"></a><h3 class="anchor"><code><a href="#switchTo"><span class="identifier">switchTo</span></a>(<span style="white-space:nowrap">nextState:<a class="type" title="flixel.FlxState - This is the basic game "state" object - e." href="./flixel/FlxState.html">FlxState</a></span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></h3><div class="doc"><p>Called from <code><a href="../flixel/FlxG.html#switchState">FlxG.switchState</a>()</code>. If <code><a href="../Bool.html">false</a></code> is returned, the state
switch is cancelled - the default implementation returns <code><a href="../Bool.html">true</a></code>.</p>
<p>Useful for customizing state switches, e.g. for transition effects.</p></div></div></div><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.group.FlxTypedGroup - This is an organizational class that can update and render a bunch of FlxBasics." href="./flixel/group/FlxTypedGroup.html">FlxTypedGroup</a></h4><div style="display:none"><div class="field "><a name="add"></a><h3 class="anchor"><code><a href="#add"><span class="identifier">add</span></a>(<span style="white-space:nowrap">Object:<span class="type">T</span></span>):<span class="type">T</span></code></h3><div class="doc"><p>Adds a new <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> subclass (<code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code>, <code><a href="../../flixel/FlxSprite.html#FlxSprite">FlxSprite</a></code>, <code>Enemy</code>, etc) to the group.
<code><a href="../../flixel/group/FlxGroup.html#FlxGroup">FlxGroup</a></code> will try to replace a <code>null</code> member of the array first.
Failing that, <code><a href="../../flixel/group/FlxGroup.html#FlxGroup">FlxGroup</a></code> will add it to the end of the member array.
WARNING: If the group has a <code>maxSize</code> that has already been met,
the object will NOT be added to the group!</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Object</code></th><td><p>The object you want to add to the group.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The same <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> object that was passed in.</p></div></div></div><div class="field "><a name="clear"></a><h3 class="anchor"><code><a href="#clear"><span class="identifier">clear</span></a>():<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Remove all instances of <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> subclasses (<code><a href="../../flixel/FlxSprite.html#FlxSprite">FlxSprite</a></code>, <code><a href="../../flixel/tile/FlxTileblock.html#FlxTileblock">FlxTileblock</a></code>, etc) from the list.
WARNING: does not <code>destroy()</code> or <code>kill()</code> any of these objects!</p></div></div><div class="field "><a name="countDead"></a><h3 class="anchor"><code><a href="#countDead"><span class="identifier">countDead</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Call this function to find out how many members of the group are dead.</p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The number of <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code>s flagged as dead. Returns <code>-1</code> if group is empty.</p></div></div></div><div class="field "><a name="countLiving"></a><h3 class="anchor"><code><a href="#countLiving"><span class="identifier">countLiving</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Call this function to find out how many members of the group are not dead.</p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The number of <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code>s flagged as not dead. Returns <code>-1</code> if group is empty.</p></div></div></div><div class="field "><a name="forEach"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Recurse : false })</span><a href="#forEach"><span class="identifier">forEach</span></a>(<span style="white-space:nowrap">Function:<span class="type">T</span> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>,</span> <span style="white-space:nowrap">Recurse:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false</span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Applies a function to all members.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Function</code></th><td><p>A function that modifies one element at a time.</p></td></tr><tr><th style="width:25%;"><code>Recurse</code></th><td><p>Whether or not to apply the function to members of subgroups as well.</p></td></tr></table></div></div><div class="field "><a name="forEachAlive"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Recurse : false })</span><a href="#forEachAlive"><span class="identifier">forEachAlive</span></a>(<span style="white-space:nowrap">Function:<span class="type">T</span> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>,</span> <span style="white-space:nowrap">Recurse:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false</span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Applies a function to all <code>alive</code> members.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Function</code></th><td><p>A function that modifies one element at a time.</p></td></tr><tr><th style="width:25%;"><code>Recurse</code></th><td><p>Whether or not to apply the function to members of subgroups as well.</p></td></tr></table></div></div><div class="field "><a name="forEachDead"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Recurse : false })</span><a href="#forEachDead"><span class="identifier">forEachDead</span></a>(<span style="white-space:nowrap">Function:<span class="type">T</span> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>,</span> <span style="white-space:nowrap">Recurse:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false</span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Applies a function to all dead members.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Function</code></th><td><p>A function that modifies one element at a time.</p></td></tr><tr><th style="width:25%;"><code>Recurse</code></th><td><p>Whether or not to apply the function to members of subgroups as well.</p></td></tr></table></div></div><div class="field "><a name="forEachExists"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Recurse : false })</span><a href="#forEachExists"><span class="identifier">forEachExists</span></a>(<span style="white-space:nowrap">Function:<span class="type">T</span> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>,</span> <span style="white-space:nowrap">Recurse:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false</span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Applies a function to all existing members.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Function</code></th><td><p>A function that modifies one element at a time.</p></td></tr><tr><th style="width:25%;"><code>Recurse</code></th><td><p>Whether or not to apply the function to members of subgroups as well.</p></td></tr></table></div></div><div class="field "><a name="forEachOfType"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Recurse : false })</span><a href="#forEachOfType"><span class="identifier">forEachOfType</span></a><<span class="type">K</span>>(<span style="white-space:nowrap">ObjectClass:<a class="type" title="Class - An abstract type that represents a Class." href="./Class.html">Class</a><<span class="type">K</span>>,</span> <span style="white-space:nowrap">Function:<span class="type">K</span> ‑> <a class="type" title="Void - The standard Void type." href="./Void.html">Void</a>,</span> <span style="white-space:nowrap">Recurse:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false</span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Applies a function to all members of type <code><a href="../../Class.html">Class</a><K></code>.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>ObjectClass</code></th><td><p>A class that objects will be checked against before Function is applied, ex: <code><a href="../../flixel/FlxSprite.html#FlxSprite">FlxSprite</a></code>.</p></td></tr><tr><th style="width:25%;"><code>Function</code></th><td><p>A function that modifies one element at a time.</p></td></tr><tr><th style="width:25%;"><code>Recurse</code></th><td><p>Whether or not to apply the function to members of subgroups as well.</p></td></tr></table></div></div><div class="field "><a name="getFirstAlive"></a><h3 class="anchor"><code><a href="#getFirstAlive"><span class="identifier">getFirstAlive</span></a>():<span class="type">T</span></code></h3><div class="doc"><p>Call this function to retrieve the first object with <code>dead == <a href="../../Bool.html">false</a></code> in the group.
This is handy for checking if everything's wiped out, or choosing a squad leader, etc.</p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> currently flagged as not dead.</p></div></div></div><div class="field "><a name="getFirstAvailable"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Force : false })</span><a href="#getFirstAvailable"><span class="identifier">getFirstAvailable</span></a>(<span style="white-space:nowrap">?ObjectClass:<a class="type" title="Class - An abstract type that represents a Class." href="./Class.html">Class</a><<span class="type">T</span>>,</span> <span style="white-space:nowrap">Force:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false</span>):<span class="type">T</span></code></h3><div class="doc"><p>Call this function to retrieve the first object with <code>exists == <a href="../../Bool.html">false</a></code> in the group.
This is handy for recycling in general, e.g. respawning enemies.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>ObjectClass</code></th><td><p>An optional parameter that lets you narrow the
results to instances of this particular class.</p></td></tr><tr><th style="width:25%;"><code>Force</code></th><td><p>Force the object to be an <code>ObjectClass</code> and not a super class of <code>ObjectClass</code>.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> currently flagged as not existing.</p></div></div></div><div class="field "><a name="getFirstDead"></a><h3 class="anchor"><code><a href="#getFirstDead"><span class="identifier">getFirstDead</span></a>():<span class="type">T</span></code></h3><div class="doc"><p>Call this function to retrieve the first object with <code>dead == <a href="../../Bool.html">true</a></code> in the group.
This is handy for checking if everything's wiped out, or choosing a squad leader, etc.</p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> currently flagged as dead.</p></div></div></div><div class="field "><a name="getFirstExisting"></a><h3 class="anchor"><code><a href="#getFirstExisting"><span class="identifier">getFirstExisting</span></a>():<span class="type">T</span></code></h3><div class="doc"><p>Call this function to retrieve the first object with <code>exists == <a href="../../Bool.html">true</a></code> in the group.
This is handy for checking if everything's wiped out, or choosing a squad leader, etc.</p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> currently flagged as existing.</p></div></div></div><div class="field "><a name="getFirstNull"></a><h3 class="anchor"><code><a href="#getFirstNull"><span class="identifier">getFirstNull</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Call this function to retrieve the first index set to <code>null</code>.
Returns <code>-1</code> if no index stores a <code>null</code> object.</p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>An <code><a href="../../Int.html">Int</a></code> indicating the first <code>null</code> slot in the group.</p></div></div></div><div class="field "><a name="getRandom"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Length : 0, StartIndex : 0 })</span><a href="#getRandom"><span class="identifier">getRandom</span></a>(<span style="white-space:nowrap">StartIndex:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a> = 0,</span> <span style="white-space:nowrap">Length:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a> = 0</span>):<span class="type">T</span></code></h3><div class="doc"><p>Returns a member at random from the group.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>StartIndex</code></th><td><p>Optional offset off the front of the array.
Default value is <code>0</code>, or the beginning of the array.</p></td></tr><tr><th style="width:25%;"><code>Length</code></th><td><p>Optional restriction on the number of values you want to randomly select from.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> from the <code>members</code> list.</p></div></div></div><div class="field "><a name="insert"></a><h3 class="anchor"><code><a href="#insert"><span class="identifier">insert</span></a>(<span style="white-space:nowrap">position:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">object:<span class="type">T</span></span>):<span class="type">T</span></code></h3><div class="doc"><p>Inserts a new <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> subclass (<code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code>, <code><a href="../../flixel/FlxSprite.html#FlxSprite">FlxSprite</a></code>, <code>Enemy</code>, etc)
into the group at the specified position.
<code><a href="../../flixel/group/FlxGroup.html#FlxGroup">FlxGroup</a></code> will try to replace a <code>null</code> member at the specified position of the array first.
Failing that, <code><a href="../../flixel/group/FlxGroup.html#FlxGroup">FlxGroup</a></code> will insert it at the position of the member array.
WARNING: If the group has a <code>maxSize</code> that has already been met,
the object will NOT be inserted to the group!</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Position</code></th><td><p>The position in the group where you want to insert the object.</p></td></tr><tr><th style="width:25%;"><code>Object</code></th><td><p>The object you want to insert into the group.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The same <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> object that was passed in.</p></div></div></div><div class="field "><a name="iterator"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#iterator"><span class="identifier">iterator</span></a>(<span style="white-space:nowrap">?filter:<span class="type">T</span> ‑> <a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></span>):<a class="type" title="flixel.group.FlxTypedGroupIterator" href="./flixel/group/FlxTypedGroupIterator.html">FlxTypedGroupIterator</a><<span class="type">T</span>></code></h3><div class="doc"><p>Iterates through every member.</p></div></div><div class="field "><a name="kill"></a><h3 class="anchor"><code><a href="#kill"><span class="identifier">kill</span></a>():<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Calls <code>kill()</code> on the group's <code>members</code> and then on the group itself.
You can revive this group later via <code>revive()</code> after this.</p></div></div><div class="field "><a name="recycle"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Revive : true, Force : false })</span><a href="#recycle"><span class="identifier">recycle</span></a>(<span style="white-space:nowrap">?ObjectClass:<a class="type" title="Class - An abstract type that represents a Class." href="./Class.html">Class</a><<span class="type">T</span>>,</span> <span style="white-space:nowrap">?ObjectFactory:() ‑> <span class="type">T</span>,</span> <span style="white-space:nowrap">Force:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false,</span> <span style="white-space:nowrap">Revive:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = true</span>):<span class="type">T</span></code></h3><div class="doc"><p>Recycling is designed to help you reuse game objects without always re-allocating or "newing" them.
It behaves differently depending on whether <code>maxSize</code> equals <code>0</code> or is bigger than <code>0</code>.</p>
<p><code>maxSize > 0</code> / "rotating-recycling" (used by <code>FlxEmitter</code>):
- at capacity: returns the next object in line, no matter its properties like <code>alive</code>, <code>exists</code> etc.
- otherwise: returns a new object.</p>
<p><code>maxSize == 0</code> / "grow-style-recycling"
- tries to find the first object with <code>exists == <a href="../../Bool.html">false</a></code>
- otherwise: adds a new object to the <code>members</code> array</p>
<p>WARNING: If this function needs to create a new object, and no object class was provided,
it will return <code>null</code> instead of a valid object!</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>ObjectClass</code></th><td><p>The class type you want to recycle (e.g. <code><a href="../../flixel/FlxSprite.html#FlxSprite">FlxSprite</a></code>, <code>EvilRobot</code>, etc).</p></td></tr><tr><th style="width:25%;"><code>ObjectFactory</code></th><td><p>Optional factory function to create a new object
if there aren't any dead members to recycle.
If <code>null</code>, <code><a href="../../Type.html#createInstance">Type.createInstance</a>()</code> is used,
which requires the class to have no constructor parameters.</p></td></tr><tr><th style="width:25%;"><code>Force</code></th><td><p>Force the object to be an <code>ObjectClass</code> and not a super class of <code>ObjectClass</code>.</p></td></tr><tr><th style="width:25%;"><code>Revive</code></th><td><p>Whether recycled members should automatically be revived
(by calling <code>revive()</code> on them).</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A reference to the object that was created.</p></div></div></div><div class="field "><a name="remove"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Splice : false })</span><a href="#remove"><span class="identifier">remove</span></a>(<span style="white-space:nowrap">Object:<span class="type">T</span>,</span> <span style="white-space:nowrap">Splice:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a> = false</span>):<span class="type">T</span></code></h3><div class="doc"><p>Removes an object from the group.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Object</code></th><td><p>The <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> you want to remove.</p></td></tr><tr><th style="width:25%;"><code>Splice</code></th><td><p>Whether the object should be cut from the array entirely or not.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The removed object.</p></div></div></div><div class="field "><a name="replace"></a><h3 class="anchor"><code><a href="#replace"><span class="identifier">replace</span></a>(<span style="white-space:nowrap">OldObject:<span class="type">T</span>,</span> <span style="white-space:nowrap">NewObject:<span class="type">T</span></span>):<span class="type">T</span></code></h3><div class="doc"><p>Replaces an existing <code><a href="../../flixel/FlxBasic.html#FlxBasic">FlxBasic</a></code> with a new one.
Does not do anything and returns <code>null</code> if the old object is not part of the group.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>OldObject</code></th><td><p>The object you want to replace.</p></td></tr><tr><th style="width:25%;"><code>NewObject</code></th><td><p>The new object you want to use instead.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The new object.</p></div></div></div><div class="field "><a name="revive"></a><h3 class="anchor"><code><a href="#revive"><span class="identifier">revive</span></a>():<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Calls <code>revive()</code> on the group's members and then on the group itself.</p></div></div><div class="field "><a name="sort"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Order : FlxSort.ASCENDING })</span><span class="label label-inline">inline</span><a href="#sort"><span class="identifier">sort</span></a>(<span style="white-space:nowrap">Function:(<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, <span class="type">T</span>, <span class="type">T</span>) ‑> <a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">Order:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a> = FlxSort.ASCENDING</span>):<a class="type" title="Void - The standard Void type." href="./Void.html">Void</a></code></h3><div class="doc"><p>Call this function to sort the group according to a particular value and order.
For example, to sort game objects for Zelda-style overlaps you might call
<code>group.sort(<a href="../../flixel/util/FlxSort.html#byY">FlxSort.byY</a>, <a href="../../flixel/util/FlxSort.html#ASCENDING">FlxSort.ASCENDING</a>)</code> at the bottom of your <code><a href="../../flixel/FlxState.html#FlxState">FlxState</a>#update()</code> override.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Function</code></th><td><p>The sorting function to use - you can use one of the premade ones in
<code><a href="../../flixel/util/FlxSort.html#FlxSort">FlxSort</a></code> or write your own using <code><a href="../../flixel/util/FlxSort.html#byValues">FlxSort.byValues</a>()</code> as a "backend".</p></td></tr><tr><th style="width:25%;"><code>Order</code></th><td><p>A constant that defines the sort order.
Possible values are <code><a href="../../flixel/util/FlxSort.html#ASCENDING">FlxSort.ASCENDING</a></code> (default) and <code><a href="../../flixel/util/FlxSort.html#DESCENDING">FlxSort.DESCENDING</a></code>.</p></td></tr></table></div></div></div><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.FlxBasic - This is a useful "generic" Flixel object." href="./flixel/FlxBasic.html">FlxBasic</a></h4><div style="display:none"><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p></p></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">© 2021 </p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>