Class AnimationComponent

Hierarchy (View Summary)

BaseComponent
- AnimationComponent

Index

Constructors

Properties

Accessors

currentFrame frames isPlaying

Methods

getContainer loadAssets pause play setContainer stop toJson update

Constructors

constructor

new AnimationComponent(props: AnimationComponentProps): AnimationComponent
Parameters
- props: AnimationComponentProps
Returns AnimationComponent
Overrides BaseComponent.constructor
- Defined in ecs/components/AnimationComponent.ts:45

Properties

`Readonly`uuid

uuid: string = ...

Accessors

currentFrame

get currentFrame(): number
Returns number
- Defined in ecs/components/AnimationComponent.ts:37

frames

get frames(): AnimationFrame[]
Returns AnimationFrame[]
- Defined in ecs/components/AnimationComponent.ts:33

isPlaying

get isPlaying(): boolean
Returns boolean
- Defined in ecs/components/AnimationComponent.ts:41

Methods

getContainer

getContainer(): undefined | IEntity
Returns undefined | IEntity
Inherited from BaseComponent.getContainer
- Defined in ecs/components/BaseComponent.ts:15

loadAssets

loadAssets(loader: DOMImageLoader): void
Parameters
- loader: DOMImageLoader
Returns void
- Defined in ecs/components/AnimationComponent.ts:51

pause

pause(): void
Returns void
- Defined in ecs/components/AnimationComponent.ts:64

play

play(): void
Returns void
- Defined in ecs/components/AnimationComponent.ts:68

setContainer

setContainer(container: IEntity): void
Parameters
- container: IEntity
Returns void
Inherited from BaseComponent.setContainer
- Defined in ecs/components/BaseComponent.ts:19

stop

stop(): void
Returns void
- Defined in ecs/components/AnimationComponent.ts:72

toJson

toJson(): WithType<AnimationComponentProps>
Returns WithType<AnimationComponentProps>
Overrides BaseComponent.toJson
- Defined in ecs/components/AnimationComponent.ts:93

update

update(deltaTime: number): void
Parameters
- deltaTime: number
Returns void
- Defined in ecs/components/AnimationComponent.ts:80