ClassAnimation & Atlases@public

FlxFramesCollection

Ordered frame views shared by sprite animation and atlas workflows.

export declare class FlxFramesCollection

Constructors

constructor(frames?: readonly FlxFrame[])

Constructs a new instance of the FlxFramesCollection class

Parameter	Type	Description
frames	readonly FlxFrame[]	-

Properties

Property	Modifiers	Type	Description
frames	-	FlxFrame[]	-
numFrames	readonly	number	-

Methods

destroy()

destroy(): void

Returns: void

static fromAtlas()

static fromAtlas(frames: FlxAtlasFrameList): FlxFramesCollection

Parameters:

Parameter	Type	Description
frames	FlxAtlasFrameList	-

Returns: FlxFramesCollection

static fromGraphicGrid()

static fromGraphicGrid(graphic: FlxGraphic, frameWidth: number, frameHeight: number, options?: FlxGridFramesOptions): FlxFramesCollection

Parameters:

Parameter	Type	Description
graphic	FlxGraphic	-
frameWidth	number	-
frameHeight	number	-
options	FlxGridFramesOptions	-

Returns: FlxFramesCollection

getByIndices()

getByIndices(indices: readonly number[]): FlxFrame[]

Parameters:

Parameter	Type	Description
indices	readonly number[]	-

Returns: FlxFrame[]

getByName()

getByName(name: string): FlxFrame

Parameters:

Parameter	Type	Description
name	string	-

Returns: FlxFrame

getByNames()

getByNames(names: readonly string[]): FlxFrame[]

Parameters:

Parameter	Type	Description
names	readonly string[]	-

Returns: FlxFrame[]

getByPrefix()

getByPrefix(prefix: string): FlxFrame[]

Parameters:

Parameter	Type	Description
prefix	string	-

Returns: FlxFrame[]

getFrame()

getFrame(index: number): FlxFrame

Parameters:

Parameter	Type	Description
index	number	-

Returns: FlxFrame

setNames()

setNames(names: readonly (string | null)[]): void

Parameters:

Parameter	Type	Description
names	readonly (string | null)[]	-

Returns: void