GraphicsComponent

Defined in: renderer/src/GraphicsComponent.ts:30

Component that wraps a PixiJS Graphics object for procedural drawing.

Extends

Component

Constructors

Constructor

new GraphicsComponent(options?): GraphicsComponent

Defined in: renderer/src/GraphicsComponent.ts:41

Parameters

options?

GraphicsComponentOptions

Returns

GraphicsComponent

Overrides

Component.constructor

Properties

enabled

enabled: boolean

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

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:1729

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: renderer/src/GraphicsComponent.ts:34

See SpriteComponent.fx.

graphics

readonly graphics: Graphics

Defined in: renderer/src/GraphicsComponent.ts:31

layerName

readonly layerName: string

Defined in: renderer/src/GraphicsComponent.ts:32

Accessors

context

Get Signature

get context(): EngineContext

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

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: renderer/src/GraphicsComponent.ts:101

The currently attached mask handle, if any. Useful after save/load to recover a handle whose caller-side reference went stale: a savable mask (rectMask, custom defineMask-registered factory) is rebuilt by afterRestore, but the handle held in user code is not.

Returns

MaskHandle | undefined

scene

Get Signature

get scene(): Scene

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

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

Methods

_runCleanups()

_runCleanups(): void

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

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:1779

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()

afterRestore(data): void

Defined in: renderer/src/GraphicsComponent.ts:69

Restore effects and mask after the graphics object is parented.

Parameters

data

GraphicsData

Returns

void

Overrides

Component.afterRestore

clearMask()

clearMask(): void

Defined in: renderer/src/GraphicsComponent.ts:90

Detach and destroy the current mask, if any.

Returns

void

draw()

draw(fn): this

Defined in: renderer/src/GraphicsComponent.ts:48

Execute a drawing function on the graphics object. Returns this for chaining.

Parameters

fn

(g) => void

Returns

this

fixedUpdate()?

optional fixedUpdate(dt): void

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

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:1771

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:1777

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: renderer/src/GraphicsComponent.ts:105

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: renderer/src/GraphicsComponent.ts:110

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:1789

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

serialize()

serialize(): GraphicsData

Defined in: renderer/src/GraphicsComponent.ts:54

Serialise to a plain object for save/load.

Returns

GraphicsData

Overrides

Component.serialize

service()

protected service<T>(key): T

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

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: renderer/src/GraphicsComponent.ts:83

Attach a mask to this graphics object. See SpriteComponent.setMask.

Parameters

factory

MaskFactory

Returns

MaskHandle

sibling()

protected sibling<C>(cls): C

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

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:1793

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:1752

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): GraphicsComponent

Defined in: renderer/src/GraphicsComponent.ts:64

Create a GraphicsComponent from a serialised snapshot.

Parameters

data

GraphicsData

Returns

GraphicsComponent