ClassTypes & Utilities@public

FlxGroup

Mutation-safe collection that owns member lifecycle traversal.

export declare class FlxGroup<T extends FlxBasic = FlxBasic> extends FlxBasic

Constructors

constructor(maxSize?: number)

Constructs a new instance of the FlxGroup class

Parameter	Type	Description
maxSize	number	-

Properties

Property	Modifiers	Type	Description
ASCENDING	static readonly	``	-
DESCENDING	static readonly	``	-
length	-	number	-
maxSize	-	number	-
members	-	(T | null)[]	-

Methods

add()

add(object: T): T

Parameters:

Parameter	Type	Description
object	T	-

Returns: T

callAll()

callAll(functionName: string, recurse?: boolean): void

Parameters:

Parameter	Type	Description
functionName	string	-
recurse	boolean	-

Returns: void

clear()

clear(): void

Returns: void

countDead()

countDead(): number

Returns: number

countLiving()

countLiving(): number

Returns: number

destroy()

destroy(): void

Returns: void

draw()

draw(): void

Returns: void

getFirstAlive()

getFirstAlive(): T | null

Returns: T | null

getFirstAvailable()

getFirstAvailable(objectClass?: FlxBasicConstructor<T>): T | null

Parameters:

Parameter	Type	Description
objectClass	FlxBasicConstructor<T>	-

Returns: T | null

getFirstDead()

getFirstDead(): T | null

Returns: T | null

getFirstExtant()

getFirstExtant(): T | null

Returns: T | null

getFirstNull()

getFirstNull(): number

Returns: number

getRandom()

getRandom(startIndex?: number, length?: number): T | null

Parameters:

Parameter	Type	Description
startIndex	number	-
length	number	-

Returns: T | null

kill()

kill(): void

Returns: void

preUpdate()

preUpdate(): void

Groups do not count themselves as active gameplay objects.

Returns: void

recycle()

recycle(objectClass?: FlxBasicConstructor<T>): T | null

Parameters:

Parameter	Type	Description
objectClass	FlxBasicConstructor<T>	-

Returns: T | null

remove()

remove(object: T, splice?: boolean): T | null

Parameters:

Parameter	Type	Description
object	T	-
splice	boolean	-

Returns: T | null

replace()

replace(oldObject: T, newObject: T): T | null

Parameters:

Parameter	Type	Description
oldObject	T	-
newObject	T	-

Returns: T | null

setAll()

setAll(variableName: string, value: unknown, recurse?: boolean): void

Parameters:

Parameter	Type	Description
variableName	string	-
value	unknown	-
recurse	boolean	-

Returns: void

sort()

sort(index?: string, order?: number): void

Parameters:

Parameter	Type	Description
index	string	-
order	number	-

Returns: void

update()

update(): void

Traverses a stable snapshot. Additions wait until the next traversal; members removed before their turn are skipped.

Returns: void