Class AnimatedSpriteComponent

Hierarchy

Component
- AnimatedSpriteComponent

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AnimatedSpriteComponent(data: AnimatedSpriteComponentData): AnimatedSpriteComponent

Overrides Component.constructor
- Defined in components/animatedspritecomponent.ts:25
Class Constructor

Parameters
- data: AnimatedSpriteComponentData
Returns AnimatedSpriteComponent

Properties

Private _autoPlay

_autoPlay: boolean

Protected _data

_data: IComponentData

Protected _owner

_owner: undefined | Entity

Private _sprite

_sprite: AnimatedSprite

name

name: string

Accessors

owner

get owner(): undefined | Entity

Inherited from Component.owner
- Defined in components/component.ts:13
Gets the owner of the component.

Returns undefined | Entity
Entity

sprite

get sprite(): AnimatedSprite

- Defined in components/animatedspritecomponent.ts:18
Gets the document

Returns AnimatedSprite
AnimatedSprite

Methods

destroy

destroy(): void

Inherited from Component.destroy
- Defined in components/component.ts:28
Destroys the component.

Returns void
void

isPlaying

isPlaying(): boolean

- Defined in components/animatedspritecomponent.ts:35
Checks if the animation is playing.

Returns boolean
boolean

load

load(): void

Overrides Component.load
- Defined in components/animatedspritecomponent.ts:42
Lodas the animated sprite.

Returns void
void

play

play(): void

- Defined in components/animatedspritecomponent.ts:49
Plays the animated sprite.

Returns void
void

render

render(shader: Shader): void

Overrides Component.render
- Defined in components/animatedspritecomponent.ts:57
Draws the sprite to the screen.

Parameters
- shader: Shader
Returns void
void

setFrame

setFrame(frameNumber: number): void

- Defined in components/animatedspritecomponent.ts:66
Sets the current frame to render.

Parameters
- frameNumber: number
Returns void
void

setOwner

setOwner(owner: Entity): void

Inherited from Component.setOwner
- Defined in components/component.ts:51
Sets the owner as the entity given.

Parameters
- owner: Entity
Returns void
void

stop

stop(): void

- Defined in components/animatedspritecomponent.ts:73
Stops the animated sprite from playing.

Returns void
void

update

update(delta: number): void

Overrides Component.update
- Defined in components/animatedspritecomponent.ts:81
Updates the animated sprite running.

Parameters
- delta: number
Returns void
void

updateReady

updateReady(): void

Overrides Component.updateReady
- Defined in components/animatedspritecomponent.ts:89
Checks if the sprite is ready to play.

Returns void
void

Generated using TypeDoc