SpriteComponent

Defined in: packages/renderer/src/SpriteComponent.ts:87

Component that displays a PixiJS Sprite.

Extends

Component

Constructors

Constructor

new SpriteComponent(options): SpriteComponent

Defined in: packages/renderer/src/SpriteComponent.ts:105

Parameters

options

SpriteComponentOptions

Returns

SpriteComponent

Overrides

Component.constructor

Properties

enabled

enabled: boolean

Defined in: packages/core/dist/index.d.ts:1872

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

Inherited from

Component.enabled

entity

entity: Entity

Defined in: packages/core/dist/index.d.ts:1870

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

fx

readonly fx: EffectsHost

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

Component-scope effects host. .fx.addEffect(...) attaches a filter to this sprite; the effect is torn down automatically when the entity or component is destroyed. .fx.findEffect(definition) recovers the handle for the first matching effect after save/load.

layerName

readonly layerName: string

Defined in: packages/renderer/src/SpriteComponent.ts:89

sprite

readonly sprite: Sprite

Defined in: packages/renderer/src/SpriteComponent.ts:88

Accessors

alpha

Get Signature

get alpha(): number

Defined in: packages/renderer/src/SpriteComponent.ts:217

Get the sprite’s alpha (opacity).

Returns

number

Set Signature

set alpha(alpha): void

Defined in: packages/renderer/src/SpriteComponent.ts:212

Set the sprite’s alpha (opacity).

Parameters

alpha

number

Returns

void

context

Get Signature

get context(): EngineContext

Defined in: packages/core/dist/index.d.ts:1885

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

Returns

EngineContext

Inherited from

Component.context

mask

Get Signature

get mask(): MaskHandle | undefined

Defined in: packages/renderer/src/SpriteComponent.ts:242

The currently attached mask handle, if any. Useful after save/load to recover a handle whose caller-side reference went stale.

Returns

MaskHandle | undefined

renderObject

Get Signature

get renderObject(): Container

Defined in: packages/renderer/src/SpriteComponent.ts:257

The underlying Pixi display object.

Returns

Container

scene

Get Signature

get scene(): Scene

Defined in: packages/core/dist/index.d.ts:1880

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over threading through this.entity.scene in component code.

Returns

Scene

Inherited from

Component.scene

tint

Get Signature

get tint(): number

Defined in: packages/renderer/src/SpriteComponent.ts:207

Get the sprite’s tint color.

Returns

number

Set Signature

set tint(color): void

Defined in: packages/renderer/src/SpriteComponent.ts:202

Set the sprite’s tint color.

Parameters

color

number

Returns

void

Methods

_runCleanups()

_runCleanups(): void

Defined in: packages/core/dist/index.d.ts:1926

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: packages/core/dist/index.d.ts:1920

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()

afterRestore(data): void

Defined in: packages/renderer/src/SpriteComponent.ts:174

Restore effects and mask after the sprite is parented in the scene tree.

Parameters

data

SpriteData

Returns

void

Overrides

Component.afterRestore

clearMask()

clearMask(): void

Defined in: packages/renderer/src/SpriteComponent.ts:233

Detach and destroy the current mask, if any.

Returns

void

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: packages/core/dist/index.d.ts:1936

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

inspectRender()

inspectRender(): object

Defined in: packages/renderer/src/SpriteComponent.ts:252

Derived render facet for the Inspector — world-space bounds and the component’s own (local, non-inherited) visible flag, computed on demand from the live sprite. Not part of serialize(); see computeRenderFacet for the bounds coordinate space.

Returns

bounds

bounds: { height: number; width: number; x: number; y: number; } | null

Axis-aligned bounding box of the component’s geometry, in world space (the same coordinate space the Inspector reports for entity.transform — pixels, before camera/viewport projection). Measured from the geometry itself, so a sized-but-hidden object still reports its real box; null means there is no measurable geometry at all (an empty Graphics, a zero-area object), NOT that the object is hidden. Read RenderFacetSnapshot.visible for the hidden/shown state.

visible

visible: boolean

The component’s own (local, non-inherited) visibility flag at snapshot time. A hidden ancestor (e.g. a parent/layer container set invisible) is NOT folded in — read the relevant parent separately if you need the fully resolved on-screen state.

listen()

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

Defined in: packages/core/dist/index.d.ts:1912

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: packages/core/dist/index.d.ts:1918

Subscribe to scene-level events, auto-unsubscribe on removal. Handlers fire for bubbled entity events (entity = source) and scene.emit events (entity = undefined).

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity?) => void

Returns

void

Inherited from

Component.listenScene

onAdd()

onAdd(): void

Defined in: packages/renderer/src/SpriteComponent.ts:261

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: packages/renderer/src/SpriteComponent.ts:266

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

Returns

void

Overrides

Component.onDestroy

onRemove()?

optional onRemove(): void

Defined in: packages/core/dist/index.d.ts:1930

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

serialize()

serialize(): SpriteData | null

Defined in: packages/renderer/src/SpriteComponent.ts:149

Serialise to a plain object for save/load.

Returns

SpriteData | null

Overrides

Component.serialize

service()

protected service<T>(key): T

Defined in: packages/core/dist/index.d.ts:1902

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

readonly input = this.service(InputManagerKey);

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

setMask()

setMask(factory): MaskHandle

Defined in: packages/renderer/src/SpriteComponent.ts:226

Attach a mask to this sprite, replacing any existing mask. Returns a handle for inverse toggling, redraw (graphicsMask), or removal. The mask is torn down automatically when the component is destroyed.

Parameters

factory

MaskFactory

Returns

MaskHandle

setTexture()

setTexture(texture): void

Defined in: packages/renderer/src/SpriteComponent.ts:138

Replace the sprite’s texture.

Parameters

texture

TextureInput

Returns

void

sibling()

protected sibling<C>(cls): C

Defined in: packages/core/dist/index.d.ts:1910

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: packages/core/dist/index.d.ts:1934

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: packages/core/dist/index.d.ts:1893

Resolve a service by key, cached after first lookup. Scene-scoped values (registered via scene._registerScoped) take precedence over engine scope. A key declared with scope: "scene" that falls back to engine scope emits a one-shot dev warning — almost always signals a missed beforeEnter hook.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use

fromSnapshot()

static fromSnapshot(data): SpriteComponent

Defined in: packages/renderer/src/SpriteComponent.ts:188

Create a SpriteComponent from a serialised snapshot.

Parameters

data

SpriteData

Returns

SpriteComponent