ClassGame Objects & Sprites@public

FlxSpriteGroup

A transformable sprite composite backed by a logical FlxGroup.

Members use world-space x/y while owned. add() interprets an incoming member position as local to the composite and translates it into world space; remove() converts it back to local space. Collision expands to the member AABBs rather than treating the composite as one rectangle.

export declare class FlxSpriteGroup<T extends FlxSprite = FlxSprite> extends FlxSprite

Constructors

constructor(x?: number, y?: number, maxSize?: number)

Constructs a new instance of the FlxSpriteGroup class

Parameter	Type	Description
x	number	-
y	number	-
maxSize	number	-

Properties

Property	Modifiers	Type	Description
alpha	-	number	-
color	-	number	-
directAlpha	-	boolean	-
group	readonly	FlxGroup<T>	-
length	readonly	number	-
maxSize	-	number	-
members	readonly	(T | null)[]	-
solid	-	boolean	-

Methods

add()

add(sprite: T): T

Parameters:

Parameter	Type	Description
sprite	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

contains()

contains(sprite: FlxSprite, recurse?: boolean): boolean

Parameters:

Parameter	Type	Description
sprite	FlxSprite	-
recurse	boolean	-

Returns: boolean

countDead()

countDead(): number

Returns: number

countLiving()

countLiving(): number

Returns: number

createGroup()

protected createGroup(maxSize: number): FlxGroup<T>

Parameters:

Parameter	Type	Description
maxSize	number	-

Returns: FlxGroup<T>

createRenderHandle()

createRenderHandle(): FlxRenderHandle

Returns: FlxRenderHandle

destroy()

destroy(): void

Returns: void

draw()

draw(): void

Returns: void

findMaxX()

findMaxX(): number

Returns: number

findMaxY()

findMaxY(): number

Returns: number

findMinX()

findMinX(): number

Returns: number

findMinY()

findMinY(): number

Returns: number

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

getMemberLocalPosition()

getMemberLocalPosition(member: T, out?: FlxPoint): FlxPoint

Returns a member position relative to this composite's translation.

Parameters:

Parameter	Type	Description
member	T	-
out	FlxPoint	-

Returns: FlxPoint

getRandom()

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

Parameters:

Parameter	Type	Description
startIndex	number	-
length	number	-

Returns: T | null

getWorldPosition()

getWorldPosition(local: Readonly<FlxPoint>, out?: FlxPoint): FlxPoint

Converts a translation-local point into authoritative world space.

Parameters:

Parameter	Type	Description
local	Readonly<FlxPoint>	-
out	FlxPoint	-

Returns: FlxPoint

kill()

kill(): void

Returns: void

multiTransformChildren()

multiTransformChildren<V>(transforms: readonly FlxSpriteTransform<T, V>[], values: readonly V[]): void

Applies several transforms to every existing direct member.

Parameters:

Parameter	Type	Description
transforms	readonly FlxSpriteTransform<T, V>[]	-
values	readonly V[]	-

Returns: void

onScreen()

onScreen(camera?: FlxCameraLike): boolean

Parameters:

Parameter	Type	Description
camera	FlxCameraLike	-

Returns: boolean

overlaps()

overlaps(objectOrGroup: FlxBasic): boolean

Parameters:

Parameter	Type	Description
objectOrGroup	FlxBasic	-

Returns: boolean

overlapsAt()

overlapsAt(x: number, y: number, objectOrGroup: FlxBasic): boolean

Parameters:

Parameter	Type	Description
x	number	-
y	number	-
objectOrGroup	FlxBasic	-

Returns: boolean

overlapsPoint()

overlapsPoint(point: Readonly<FlxPoint>): boolean

Parameters:

Parameter	Type	Description
point	Readonly<FlxPoint>	-

Returns: boolean

recycle()

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

Parameters:

Parameter	Type	Description
objectClass	FlxBasicConstructor<T>	-

Returns: T | null

remove()

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

Parameters:

Parameter	Type	Description
sprite	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

reset()

reset(x: number, y: number): void

Parameters:

Parameter	Type	Description
x	number	-
y	number	-

Returns: void

revive()

revive(): void

Returns: void

setAll()

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

Parameters:

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

Returns: void

setMemberLocalPosition()

setMemberLocalPosition(member: T, x: number, y: number): T

Moves an owned member using translation-local coordinates.

Parameters:

Parameter	Type	Description
member	T	-
x	number	-
y	number	-

Returns: T

sort()

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

Parameters:

Parameter	Type	Description
index	string	-
order	number	-

Returns: void

transformChildren()

transformChildren<V>(transform: FlxSpriteTransform<T, V>, value: V): void

Applies one property transform to every direct member in stable order.

Parameters:

Parameter	Type	Description
transform	FlxSpriteTransform<T, V>	-
value	V	-

Returns: void

update()

update(): void

Returns: void