substates.PauseOptions - Leather Engine Documentation

Adds a new FlxBasic subclass (FlxBasic, FlxSprite, Enemy, etc) to the group. FlxGroup will try to replace a null member of the array first. Failing that, FlxGroup will add it to the end of the member array. WARNING: If the group has a maxSize that has already been met, the object will NOT be added to the group!

Parameters:

`basic`	The `FlxBasic` you want to add to the group.

Returns:

The same FlxBasic object that was passed in.

`any(func:T ‑> Bool):Bool`

Tests whether any member satisfies the function.

Parameters:

`func`	The function that tests the members

Available since

5.4.0

`clear():Void`

Remove all instances of FlxBasic subclasses (FlxSprite, FlxTileblock, etc) from the list. WARNING: does not destroy() or kill() any of these objects!

`countDead():Int`

Call this function to find out how many members of the group are dead.

Returns:

The number of FlxBasics flagged as dead. Returns -1 if group is empty.

`countLiving():Int`

Call this function to find out how many members of the group are not dead.

Returns:

The number of FlxBasics flagged as not dead. Returns -1 if group is empty.

`every(func:T ‑> Bool):Bool`

Tests whether every member satisfies the function.

Parameters:

`func`	The function that tests the members

Available since

5.4.0

`@:value({ recurse : false })forEach(func:T ‑> Void, recurse:Bool = false):Void`

Applies a function to all members.

Parameters:

`func`	A function that modifies one element at a time.
`recurse`	Whether or not to apply the function to members of subgroups as well.

`@:value({ recurse : false })forEachAlive(func:T ‑> Void, recurse:Bool = false):Void`

Applies a function to all alive members.

Parameters:

`func`	A function that modifies one element at a time.
`recurse`	Whether or not to apply the function to members of subgroups as well.

`@:value({ recurse : false })forEachDead(func:T ‑> Void, recurse:Bool = false):Void`

Applies a function to all dead members.

Parameters:

`func`	A function that modifies one element at a time.
`recurse`	Whether or not to apply the function to members of subgroups as well.

`@:value({ recurse : false })forEachExists(func:T ‑> Void, recurse:Bool = false):Void`

Applies a function to all existing members.

Parameters:

`func`	A function that modifies one element at a time.
`recurse`	Whether or not to apply the function to members of subgroups as well.

`@:value({ recurse : false })forEachOfType<K>(objectClass:Class<K>, func:K ‑> Void, recurse:Bool = false):Void`

Applies a function to all members of type Class<K>.

Parameters:

`objectClass`	A class that objects will be checked against before Function is applied, ex: `FlxSprite`.
`func`	A function that modifies one element at a time.
`recurse`	Whether or not to apply the function to members of subgroups as well.

`getFirst(func:T ‑> Bool):Null<T>`

Searches for, and returns the first member that satisfies the function.

Parameters:

`func`	The function that tests the members

Available since

5.4.0

`getFirstAlive():Null<T>`

Call this function to retrieve the first object with dead == false in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc.

Returns:

A FlxBasic currently flagged as not dead.

`@:value({ force : false })getFirstAvailable(?objectClass:Class<T>, force:Bool = false):Null<T>`

Call this function to retrieve the first object with exists == false in the group. This is handy for recycling in general, e.g. respawning enemies.

Parameters:

`objectClass`	An optional parameter that lets you narrow the results to instances of this particular class.
`force`	Force the object to be an `ObjectClass` and not a super class of `ObjectClass`.

Returns:

A FlxBasic currently flagged as not existing.

`getFirstDead():Null<T>`

Call this function to retrieve the first object with dead == true in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc.

Returns:

A FlxBasic currently flagged as dead.

`getFirstExisting():Null<T>`

Call this function to retrieve the first object with exists == true in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc.

Returns:

A FlxBasic currently flagged as existing.

`getFirstIndex(func:T ‑> Bool):Int`

Searches for, and returns the index of the first member that satisfies the function.

Parameters:

`func`	The function that tests the members

Available since

5.4.0

`getFirstNull():Int`

Call this function to retrieve the first index set to null. Returns -1 if no index stores a null object.

Returns:

An Int indicating the first null slot in the group.

`getLast(func:T ‑> Bool):Null<T>`

Searches for, and returns the last member that satisfies the function.

Parameters:

`func`	The function that tests the members

Available since

5.4.0

`getLastIndex(func:T ‑> Bool):Int`

Searches for, and returns the index of the last member that satisfies the function.

Parameters:

`func`	The function that tests the members

Available since

5.4.0

`@:value({ length : 0, startIndex : 0 })getRandom(startIndex:Int = 0, length:Int = 0):T`

Returns a member at random from the group.

Parameters:

`startIndex`	Optional offset off the front of the array. Default value is `0`, or the beginning of the array.
`length`	Optional restriction on the number of values you want to randomly select from.

Returns:

A FlxBasic from the members list.

`insert(position:Int, object:T):T`

Inserts a new FlxBasic subclass (FlxBasic, FlxSprite, Enemy, etc) into the group at the specified position. FlxGroup will try to replace a null member at the specified position of the array first. Failing that, FlxGroup will insert it at the position of the member array. WARNING: If the group has a maxSize that has already been met, the object will NOT be inserted to the group!

Parameters:

`position`	The position in the group where you want to insert the object.
`object`	The object you want to insert into the group.

Returns:

The same FlxBasic object that was passed in.

`inlineiterator(?filter:T ‑> Bool):FlxTypedGroupIterator<T>`

Iterates through every member.

`inlinekeyValueIterator():ArrayKeyValueIterator<T>`

Iterates through every member and index.

`kill():Void`

Calls killMembers() and then kills the group itself. Revive this group via revive().

`killMembers():Void`

Calls kill() on the group's unkilled members. Revive them via reviveMembers().

Available since

5.4.0

`@:value({ revive : true, force : false })recycle(?objectClass:Class<T>, ?objectFactory:() ‑> T, force:Bool = false, revive:Bool = true):T`

Recycling is designed to help you reuse game objects without always re-allocating or "newing" them. It behaves differently depending on whether maxSize equals 0 or is bigger than 0.

maxSize > 0 / "rotating-recycling" (used by FlxEmitter): - at capacity: returns the next object in line, no matter its properties like alive, exists etc. - otherwise: returns a new object.

maxSize == 0 / "grow-style-recycling" - tries to find the first object with exists == false - otherwise: adds a new object to the members array

WARNING: If this function needs to create a new object, and no object class was provided, it will return null instead of a valid object!

Parameters:

`objectClass`	The class type you want to recycle (e.g. `FlxSprite`, `EvilRobot`, etc).
`objectFactory`	Optional factory function to create a new object if there aren't any dead members to recycle. If `null`, `Type.createInstance()` is used, which requires the class to have no constructor parameters.
`force`	Force the object to be an `ObjectClass` and not a super class of `ObjectClass`.
`revive`	Whether recycled members should automatically be revived (by calling `revive()` on them).

Returns:

A reference to the object that was created.

`@:value({ splice : false })remove(basic:T, splice:Bool = false):T`

Removes an object from the group.

Parameters:

`basic`	The `FlxBasic` you want to remove.
`splice`	Whether the object should be cut from the array entirely or not.

Returns:

The removed object.

`replace(oldObject:T, newObject:T):T`

Replaces an existing FlxBasic with a new one. Does not do anything and returns null if the old object is not part of the group.

Parameters:

`oldObject`	The object you want to replace.
`newObject`	The new object you want to use instead.

Returns:

The new object.

`revive():Void`

Calls reviveMembers() and then revives the group itself.

`reviveMembers():Void`

Calls revive() on the group's killed members and then on the group itself.

Available since

5.4.0

`@:value({ order : FlxSort.ASCENDING })inlinesort(func:(Int, T, T) ‑> Int, order:Int = FlxSort.ASCENDING):Void`

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 group.sort(FlxSort.byY, FlxSort.ASCENDING) at the bottom of your FlxState#update() override.

Parameters:

`func`	The sorting function to use - you can use one of the premade ones in `FlxSort` or write your own using `FlxSort.byValues()` as a "backend".
`order`	A constant that defines the sort order. Possible values are `FlxSort.ASCENDING` (default) and `FlxSort.DESCENDING`.

class PauseOptions

package substates

extends OptionsMenu › MusicBeatState › ModchartMusicBeatState › FlxUIState › FlxTransitionableState › FlxState › FlxTypedContainer › FlxTypedGroup › FlxBasic

import substates.PauseSubState

Constructor

new(?defaultPage:String, ?backgroundColor:FlxColor)

Methods

Inherited Variables

Defined by OptionsMenu

@:value(0)curSelected:Int = 0

descriptionBackground:FlxSprite

descriptionText:FlxText

@:value(false)inMenu:Bool = false

menuBG:FlxSprite

@:value(new FlxTypedGroup<Option>())page:FlxTypedGroup<Option> = new FlxTypedGroup<Option>()

@:value("Categories")pageName:String = "Categories"

Defined by MusicBeatState

@:value(0)curBeat:Int = 0

@:value(0)curDecBeat:Float = 0

@:value(0)curDecStep:Float = 0

@:value(0)curStep:Int = 0

stateScript:HScript

Defined by ModchartMusicBeatState

playfieldRenderer:PlayfieldRenderer

Defined by FlxUIState

@:value(null)cursor:FlxUICursor = null

destroyed:Bool

@:value(null)getTextFallback:(String, String, Bool) ‑> String = null

@:value(false)hideCursorOnSubstate:Bool = false

@:value(false)reload_ui_on_resize:Bool = false

read onlytooltips:FlxUITooltipManager

Defined by FlxTransitionableState

read onlyhasTransIn:Bool

read onlyhasTransOut:Bool

transIn:TransitionData

transOut:TransitionData

Defined by FlxState

bgColor:FlxColor

@:value(true)destroySubStates:Bool = true

@:value(true)persistentDraw:Bool = true

@:value(false)persistentUpdate:Bool = false

read onlysubState:FlxSubState

read onlysubStateClosed:FlxTypedSignal<FlxSubState ‑> Void>

read onlysubStateOpened:FlxTypedSignal<FlxSubState ‑> Void>

Defined by FlxTypedGroup

@:value(0)read onlylength:Int = 0

maxSize:Int

read onlymemberAdded:FlxTypedSignal<T ‑> Void>

read onlymemberRemoved:FlxTypedSignal<T ‑> Void>

read onlymembers:Array<T>

@:value(true)zIndexesAllowed:Bool = true

Defined by FlxBasic

@:value(idEnumerator++)ID:Int = idEnumerator++

@:value(true)active:Bool = true

@:value(true)alive:Bool = true

camera:FlxCamera

cameras:Array<FlxCamera>

read onlycontainer:Null<FlxContainer>

@:value(true)exists:Bool = true

@:value(true)visible:Bool = true

@:value(0)zIndex:Int = 0

Inherited Methods

Defined by OptionsMenu

loadPage(loadedPageName:String):Void

Defined by MusicBeatState

beatHit():Void

@:value({ executeOn : BOTH })call(func:String, ?args:Array<Any>, executeOn:ExecuteOn = BOTH):Void

stepHit():Void

updateBeat():Void

updateCurStep():Void

Defined by FlxUIState

forceFocus(b:Bool, thing:IFlxUIWidget):Void

getEvent(id:String, sender:Dynamic, data:Dynamic, ?params:Array<Dynamic>):Void

getRequest(id:String, sender:Dynamic, data:Dynamic, ?params:Array<Dynamic>):Dynamic

@:value({ Safe : true, Context : "ui" })getText(Flag:String, Context:String = "ui", Safe:Bool = true):String

onCursorEvent(code:String, target:IFlxUIWidget):Void

onShowTooltip(t:FlxUITooltip):Void

@:value({ height : 600, width : 800 })resizeScreen(width:Float = 800, height:Float = 600):Void

setUIVariable(key:String, value:String):Void

Defined by FlxTransitionableState

`new(?defaultPage:String, ?backgroundColor:FlxColor)`

`@:value(0)curSelected:Int = 0`

`descriptionBackground:FlxSprite`

`descriptionText:FlxText`

`@:value(false)inMenu:Bool = false`

`menuBG:FlxSprite`

`@:value(new FlxTypedGroup<Option>())page:FlxTypedGroup<Option> = new FlxTypedGroup<Option>()`

`@:value("Categories")pageName:String = "Categories"`

`@:value(0)curBeat:Int = 0`

`@:value(0)curDecBeat:Float = 0`

`@:value(0)curDecStep:Float = 0`

`@:value(0)curStep:Int = 0`

`stateScript:HScript`

`playfieldRenderer:PlayfieldRenderer`

`@:value(null)cursor:FlxUICursor = null`

`destroyed:Bool`

`@:value(null)getTextFallback:(String, String, Bool) ‑> String = null`

`@:value(false)hideCursorOnSubstate:Bool = false`

`@:value(false)reload_ui_on_resize:Bool = false`

`read onlytooltips:FlxUITooltipManager`

`read onlyhasTransIn:Bool`

`read onlyhasTransOut:Bool`

`transIn:TransitionData`

`transOut:TransitionData`

`bgColor:FlxColor`

`@:value(true)destroySubStates:Bool = true`

`@:value(true)persistentDraw:Bool = true`

`@:value(false)persistentUpdate:Bool = false`

`read onlysubState:FlxSubState`

`read onlysubStateClosed:FlxTypedSignal<FlxSubState ‑> Void>`

`read onlysubStateOpened:FlxTypedSignal<FlxSubState ‑> Void>`

`@:value(0)read onlylength:Int = 0`

`maxSize:Int`

`read onlymemberAdded:FlxTypedSignal<T ‑> Void>`

`read onlymemberRemoved:FlxTypedSignal<T ‑> Void>`

`read onlymembers:Array<T>`

`@:value(true)zIndexesAllowed:Bool = true`

`@:value(idEnumerator++)ID:Int = idEnumerator++`

`@:value(true)active:Bool = true`

`@:value(true)alive:Bool = true`

`camera:FlxCamera`

`cameras:Array<FlxCamera>`

`read onlycontainer:Null<FlxContainer>`

`@:value(true)exists:Bool = true`

`@:value(true)visible:Bool = true`

`@:value(0)zIndex:Int = 0`

`loadPage(loadedPageName:String):Void`

`beatHit():Void`

`@:value({ executeOn : BOTH })call(func:String, ?args:Array<Any>, executeOn:ExecuteOn = BOTH):Void`

`stepHit():Void`

`updateBeat():Void`

`updateCurStep():Void`

`forceFocus(b:Bool, thing:IFlxUIWidget):Void`

`getEvent(id:String, sender:Dynamic, data:Dynamic, ?params:Array<Dynamic>):Void`

`getRequest(id:String, sender:Dynamic, data:Dynamic, ?params:Array<Dynamic>):Dynamic`

`@:value({ Safe : true, Context : "ui" })getText(Flag:String, Context:String = "ui", Safe:Bool = true):String`

`onCursorEvent(code:String, target:IFlxUIWidget):Void`

`onShowTooltip(t:FlxUITooltip):Void`

`@:value({ height : 600, width : 800 })resizeScreen(width:Float = 800, height:Float = 600):Void`

`setUIVariable(key:String, value:String):Void`

`transitionIn():Void`

`transitionOut(?OnExit:() ‑> Void):Void`

`createPost():Void`

`onFocus():Void`

`onFocusLost():Void`

`resetSubState():Void`

`add(basic:T):T`

`any(func:T ‑> Bool):Bool`

`clear():Void`

`countDead():Int`

`countLiving():Int`

`every(func:T ‑> Bool):Bool`

`@:value({ recurse : false })forEach(func:T ‑> Void, recurse:Bool = false):Void`

`@:value({ recurse : false })forEachAlive(func:T ‑> Void, recurse:Bool = false):Void`

`@:value({ recurse : false })forEachDead(func:T ‑> Void, recurse:Bool = false):Void`

`@:value({ recurse : false })forEachExists(func:T ‑> Void, recurse:Bool = false):Void`

`@:value({ recurse : false })forEachOfType<K>(objectClass:Class<K>, func:K ‑> Void, recurse:Bool = false):Void`

`getFirst(func:T ‑> Bool):Null<T>`

`getFirstAlive():Null<T>`

`@:value({ force : false })getFirstAvailable(?objectClass:Class<T>, force:Bool = false):Null<T>`