ParticleEmitterComponent

Defined in: particles/src/ParticleEmitterComponent.ts:30

Component that owns a PixiJS ParticleContainer and drives particle emission.

Extends

Component

Constructors

Constructor

new ParticleEmitterComponent(config): ParticleEmitterComponent

Defined in: particles/src/ParticleEmitterComponent.ts:57

Parameters

config

EmitterConfig

Returns

ParticleEmitterComponent

Overrides

Component.constructor

Properties

_accumulator

_accumulator: number = 0

Defined in: particles/src/ParticleEmitterComponent.ts:34

Internal

_active

readonly _active: ParticleState[] = []

Defined in: particles/src/ParticleEmitterComponent.ts:33

Internal

_pool

readonly _pool: ParticlePool

Defined in: particles/src/ParticleEmitterComponent.ts:32

Internal

container

readonly container: ParticleContainer

Defined in: particles/src/ParticleEmitterComponent.ts:31

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

Accessors

activeCount

Get Signature

get activeCount(): number

Defined in: particles/src/ParticleEmitterComponent.ts:130

Number of currently alive particles.

Returns

number

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

isEmitting

Get Signature

get isEmitting(): boolean

Defined in: particles/src/ParticleEmitterComponent.ts:125

Whether continuous emission is active.

Returns

boolean

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

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

_spawn()

_spawn(worldX, worldY): void

Defined in: particles/src/ParticleEmitterComponent.ts:258

Internal

Parameters

worldX

number

worldY

number

Returns

void

_update()

_update(dt, worldX, worldY): void

Defined in: particles/src/ParticleEmitterComponent.ts:197

Internal

Called by ParticleSystem each frame.

Parameters

dt

number

worldX

number

worldY

number

Returns

void

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

burst()

burst(count, worldX?, worldY?): void

Defined in: particles/src/ParticleEmitterComponent.ts:118

Spawn count particles immediately.

Parameters

count

number

worldX?

number = 0

worldY?

number = 0

Returns

void

emit()

emit(): void

Defined in: particles/src/ParticleEmitterComponent.ts:107

Start continuous emission at config.rate particles/sec.

Returns

void

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: particles/src/ParticleEmitterComponent.ts:182

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: particles/src/ParticleEmitterComponent.ts:188

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(): ParticleEmitterData | null

Defined in: particles/src/ParticleEmitterComponent.ts:134

Return a JSON-serializable snapshot of this component’s state. Used by the save system.

Returns

ParticleEmitterData | 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

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

stop()

stop(): void

Defined in: particles/src/ParticleEmitterComponent.ts:112

Stop continuous emission. Existing particles continue to their end of life.

Returns

void

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

Defined in: particles/src/ParticleEmitterComponent.ts:162

Parameters

data

ParticleEmitterData

Returns

ParticleEmitterComponent