Class TextureFrameSequences

Manages frame sequences for animated sprites Provides utility functions for working with sprite sheet animations

Index

Constructors

Methods

addSequence getFrame getFrameFromSequence getFrameSequence getSequence

Constructors

constructor

new TextureFrameSequences(
frames: Texture<TextureSource<any>>[],
sequences?: Record<string, SequenceInfo>,
): TextureFrameSequences
Create a new TextureFrameSequences
Parameters
- frames: Texture<TextureSource<any>>[]
  Array of textures from a spritesheet
- sequences: Record<string, SequenceInfo> = {}
  Named sequences with frame indices and animation speed
Returns TextureFrameSequences
- Defined in library/texture-frame-sequences.ts:26

Methods

addSequence

addSequence(name: string, frameIndices: number[], animationSpeed?: number): void
Add a new animation sequence
Parameters
- name: string
  Unique identifier for the sequence
- frameIndices: number[]
  Array of frame indices from the texture atlas
- animationSpeed: number = 1
  Speed of animation (frames per ms)
Returns void
- Defined in library/texture-frame-sequences.ts:37

getFrame

getFrame(index: number): Texture<TextureSource<any>>
Get a specific frame by index
Parameters
- index: number
Returns Texture<TextureSource<any>>
- Defined in library/texture-frame-sequences.ts:54

getFrameFromSequence

getFrameFromSequence(
sequenceName: string,
frameIndex: number,
): Texture<TextureSource<any>>
Get a specific frame from a sequence by index
Parameters
- sequenceName: string
- frameIndex: number
Returns Texture<TextureSource<any>>
- Defined in library/texture-frame-sequences.ts:61

getFrameSequence

getFrameSequence(name: string): Texture<TextureSource<any>>[]
Get all frames for a sequence
Parameters
- name: string
Returns Texture<TextureSource<any>>[]
- Defined in library/texture-frame-sequences.ts:75

getSequence

getSequence(name: string): SequenceInfo
Get a sequence by name
Parameters
- name: string
Returns SequenceInfo
- Defined in library/texture-frame-sequences.ts:47