SpriteComponent

Defined in: renderer/src/SpriteComponent.ts:35

Component that displays a PixiJS Sprite.

Extends

Component

Constructors

Constructor

new SpriteComponent(options): SpriteComponent

Defined in: renderer/src/SpriteComponent.ts:40

Parameters

options

SpriteComponentOptions

Returns

SpriteComponent

Overrides

Component.constructor

Properties

enabled

enabled: boolean

Defined in: core/dist/index.d.ts:542

Whether this component is active. Disabled components are skipped by ComponentUpdateSystem.

Inherited from

Component.enabled

entity

entity: Entity

Defined in: core/dist/index.d.ts:540

Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.

Inherited from

Component.entity

layerName

readonly layerName: string

Defined in: renderer/src/SpriteComponent.ts:37

sprite

readonly sprite: Sprite

Defined in: renderer/src/SpriteComponent.ts:36

Accessors

alpha

Get Signature

get alpha(): number

Defined in: renderer/src/SpriteComponent.ts:124

Get the sprite’s alpha (opacity).

Returns

number

Set Signature

set alpha(alpha): void

Defined in: renderer/src/SpriteComponent.ts:119

Set the sprite’s alpha (opacity).

Parameters

alpha

number

Returns

void

context

Get Signature

get context(): EngineContext

Defined in: core/dist/index.d.ts:554

Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.

Returns

EngineContext

Inherited from

Component.context

scene

Get Signature

get scene(): Scene

Defined in: core/dist/index.d.ts:549

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over this.entity.scene! in component methods.

Returns

Scene

Inherited from

Component.scene

tint

Get Signature

get tint(): number

Defined in: renderer/src/SpriteComponent.ts:114

Get the sprite’s tint color.

Returns

number

Set Signature

set tint(color): void

Defined in: renderer/src/SpriteComponent.ts:109

Set the sprite’s tint color.

Parameters

color

number

Returns

void

Methods

_runCleanups()

_runCleanups(): void

Defined in: core/dist/index.d.ts:584

Internal

Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.

Returns

void

Inherited from

Component._runCleanups

addCleanup()

protected addCleanup(fn): void

Defined in: core/dist/index.d.ts:578

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()?

optional afterRestore(data, resolve): void

Defined in: core/dist/index.d.ts:598

Called after onAdd() during save/load restoration. Apply state that depends on onAdd() having run.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Component.afterRestore

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: core/dist/index.d.ts:594

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

listen()

protected listen<T>(entity, token, handler): void

Defined in: core/dist/index.d.ts:574

Subscribe to events on any entity, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

entity

Entity

token

EventToken<T>

handler

(data) => void

Returns

void

Inherited from

Component.listen

listenScene()

protected listenScene<T>(token, handler): void

Defined in: core/dist/index.d.ts:576

Subscribe to scene-level bubbled events, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity) => void

Returns

void

Inherited from

Component.listenScene

onAdd()

onAdd(): void

Defined in: renderer/src/SpriteComponent.ts:128

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: renderer/src/SpriteComponent.ts:134

Called when the component is destroyed (entity destroyed or component removed).

Returns

void

Overrides

Component.onDestroy

onRemove()?

optional onRemove(): void

Defined in: core/dist/index.d.ts:588

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

serialize()

serialize(): SpriteData | null

Defined in: renderer/src/SpriteComponent.ts:77

Serialise to a plain object for save/load.

Returns

SpriteData | null

Overrides

Component.serialize

service()

protected service<T>(key): T

Defined in: core/dist/index.d.ts:564

Lazy proxy-based service resolution. Can be used at field-declaration time:

readonly camera = this.service(CameraKey);

The actual resolution is deferred until first property access.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.service

setTexture()

setTexture(texture): void

Defined in: renderer/src/SpriteComponent.ts:66

Replace the sprite’s texture.

Parameters

texture

TextureInput

Returns

void

sibling()

protected sibling<C>(cls): C

Defined in: core/dist/index.d.ts:572

Lazy proxy-based sibling component resolution. Can be used at field-declaration time:

readonly anim = this.sibling(AnimatedSpriteComponent);

The actual resolution is deferred until first property access.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

update()?

optional update(dt): void

Defined in: core/dist/index.d.ts:592

Called every frame by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.update

use()

protected use<T>(key): T

Defined in: core/dist/index.d.ts:556

Resolve a service by key, cached after first lookup.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use

fromSnapshot()

static fromSnapshot(data): SpriteComponent

Defined in: renderer/src/SpriteComponent.ts:96

Create a SpriteComponent from a serialised snapshot.

Parameters

data

SpriteData

Returns

SpriteComponent