CameraEntity

Defined in: renderer/src/CameraEntity.ts:78

Camera entity. Spawn in a scene to enable camera-based layer transforms.

const cam = this.spawn(CameraEntity, {
  follow: player.get(Transform),
  smoothing: 0.15,
  bounds: { minX: 0, minY: 0, maxX: 2000, maxY: 2000 },
});

// All camera operations are available directly on the entity:
cam.shake(8, 300);
cam.zoomTo(1.5, 1000);
cam.follow(otherTarget, { smoothing: 0.1 });

Extends

Entity

Constructors

Constructor

new CameraEntity(name?, tags?): CameraEntity

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

Parameters

name?

string

tags?

Iterable<string, any, any>

Returns

CameraEntity

Inherited from

Entity.constructor

Properties

id

readonly id: number

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

Unique auto-incrementing ID.

Inherited from

Entity.id

key?

readonly optional key?: string

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

Stable identity key, scene-scoped. Set at spawn-time when options.key is passed to scene.spawn / entity.spawnChild; undefined otherwise. Used with scene.findByKey and as a stable id in reactive stores (e.g. a createSet<string>() persisted under "world.opened").

Inherited from

Entity.key

name

readonly name: string

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

Display name for debugging.

Inherited from

Entity.name

[TRAITS_KEY]

static [TRAITS_KEY]: Set<symbol>

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

Inherited from

Entity.[TRAITS_KEY]

Accessors

bounds

Get Signature

get bounds(): CameraBounds | undefined

Defined in: renderer/src/CameraEntity.ts:152

Returns

CameraBounds | undefined

Set Signature

set bounds(value): void

Defined in: renderer/src/CameraEntity.ts:156

Parameters

value

CameraBounds | undefined

Returns

void

children

Get Signature

get children(): ReadonlyMap<string, Entity>

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

Named children as a read-only map. Empty map if no children.

Returns

ReadonlyMap<string, Entity>

Inherited from

Entity.children

effectivePosition

Get Signature

get effectivePosition(): Vec2

Defined in: renderer/src/CameraEntity.ts:160

Returns

Vec2

isDestroyed

Get Signature

get isDestroyed(): boolean

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

True if destroy() has been called.

Returns

boolean

Inherited from

Entity.isDestroyed

parent

Get Signature

get parent(): Entity | null

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

The parent entity, or null if this is a root entity.

Returns

Entity | null

Inherited from

Entity.parent

position

Get Signature

get position(): Vec2

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

Returns

Vec2

Set Signature

set position(value): void

Defined in: renderer/src/CameraEntity.ts:132

Parameters

value

Vec2

Returns

void

rotation

Get Signature

get rotation(): number

Defined in: renderer/src/CameraEntity.ts:144

Returns

number

Set Signature

set rotation(value): void

Defined in: renderer/src/CameraEntity.ts:148

Parameters

value

number

Returns

void

scene

Get Signature

get scene(): Scene

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

The scene this entity belongs to. Throws if the entity is not attached to a scene — which in practice only happens before scene.spawn / addChild wires it up, or after destroy() tears it down. Inside lifecycle methods (setup, component onAdd, update, etc.) this is always safe to access.

For the rare case where you genuinely need to inspect whether an entity has a scene (e.g. defensive code in systems iterating a query result), use tryScene instead.

Returns

Scene

Inherited from

Entity.scene

tryScene

Get Signature

get tryScene(): Scene | null

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

The scene this entity belongs to, or null if detached.

Returns

Scene | null

Inherited from

Entity.tryScene

zoom

Get Signature

get zoom(): number

Defined in: renderer/src/CameraEntity.ts:136

Returns

number

Set Signature

set zoom(value): void

Defined in: renderer/src/CameraEntity.ts:140

Parameters

value

number

Returns

void

Methods

_performDestroy()

_performDestroy(): void

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

Internal

Internal: perform actual destruction — remove all components and clear state. Called by Scene during endOfFrame flush.

Returns

void

Inherited from

Entity._performDestroy

_setKey()

_setKey(key): void

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

Internal

Internal: assign the stable identity key. Called by Scene._registerKey during spawn. Throws if the entity already has a key — keys are immutable for an entity’s lifetime.

Parameters

key

string

Returns

void

Inherited from

Entity._setKey

_setScene()

_setScene(scene, callbacks): void

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

Internal

Internal: set the scene and callbacks. Called by Scene.spawn().

Parameters

scene

Scene | null

callbacks

EntityCallbacks | null

Returns

void

Inherited from

Entity._setScene

add()

add<C>(component): C

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

Add a component instance. Returns the component for chaining.

Type Parameters

C

C extends Component

Parameters

component

C

Returns

C

Inherited from

Entity.add

addChild()

addChild(name, child): void

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

Add a named child entity. Auto-adds to parent’s scene if not already in one.

Parameters

name

string

child

Entity

Returns

void

Inherited from

Entity.addChild

afterRestore()

afterRestore(): void

Defined in: renderer/src/CameraEntity.ts:196

Called after components are restored during save/load. Rebuild non-serializable state here.

Returns

void

Overrides

Entity.afterRestore

destroy()

destroy(): void

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

Mark for deferred destruction. Actual cleanup happens at end of frame.

Returns

void

Inherited from

Entity.destroy

emit()

Call Signature

emit(token): void

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

Emit a typed event on this entity. Bubbles to the scene.

Parameters

token

EventToken<void>

Returns

void

Inherited from

Entity.emit

Call Signature

emit<T>(token, data): void

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

Emit a typed event on this entity. Bubbles to the scene.

Type Parameters

T

T

Parameters

token

EventToken<T>

data

T

Returns

void

Inherited from

Entity.emit

follow()

follow(target, options?): void

Defined in: renderer/src/CameraEntity.ts:168

Parameters

target

position

Vec2Like

options?

CameraFollowOptions

Returns

void

get()

get<C>(cls): C

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

Get a component by class. Throws if not found.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Entity.get

getAll()

getAll(): Iterable<Component>

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

Get all components as an iterable.

Returns

Iterable<Component>

Inherited from

Entity.getAll

getChild()

getChild(name): Entity

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

Get a child by name. Throws if not found.

Parameters

name

string

Returns

Entity

Inherited from

Entity.getChild

has()

has(cls): boolean

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

Check if entity has a component of the given class.

Parameters

cls

ComponentClass

Returns

boolean

Inherited from

Entity.has

hasTrait()

hasTrait<T>(token): this is CameraEntity & T

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

Check if this entity’s class implements a given trait. Acts as a type guard.

Type Parameters

T

T

Parameters

token

TraitToken<T>

Returns

this is CameraEntity & T

Inherited from

Entity.hasTrait

on()

on<T>(token, handler): () => void

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

Subscribe to a typed event on this entity. Returns an unsubscribe function.

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data) => void

Returns

() => void

Inherited from

Entity.on

remove()

remove(cls): void

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

Remove a component by class.

Parameters

cls

ComponentClass

Returns

void

Inherited from

Entity.remove

removeChild()

removeChild(name): Entity

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

Remove a named child. Returns the detached entity.

Parameters

name

string

Returns

Entity

Inherited from

Entity.removeChild

requireKey()

requireKey(): string

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

Return the stable key, or throw if this entity was spawned without one. Use inside component setup() when the component depends on identity (e.g. reading from a createSet keyed by entity key).

Returns

string

Inherited from

Entity.requireKey

screenToWorld()

screenToWorld(screenX, screenY): Vec2

Defined in: renderer/src/CameraEntity.ts:188

Parameters

screenX

number

screenY

number

Returns

Vec2

serialize()?

optional serialize(): unknown

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

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

Returns

unknown

Inherited from

Entity.serialize

setup()

setup(params?): void

Defined in: renderer/src/CameraEntity.ts:81

Optional setup method. Called by scene.spawn(Class, params) after the entity is wired to its scene, so components can access services. Override in subclasses — do NOT use the constructor for component setup.

Parameters

params?

CameraEntityParams = {}

Returns

void

Overrides

Entity.setup

shake()

shake(intensity, duration, options?): void

Defined in: renderer/src/CameraEntity.ts:176

Parameters

intensity

number

duration

number

options?

CameraShakeOptions

Returns

void

spawnChild()

Call Signature

spawnChild(name, options?): Entity

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

Spawn a new entity in this entity’s scene and add it as a named child. Combines scene.spawn(...) + this.addChild(name, ...) in one call — the idiomatic way to compose entity trees (logical root + visual body

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Parameters

name

string

options?

SpawnOptions

Returns

Entity

Inherited from

Entity.spawnChild

Call Signature

spawnChild<E>(name, Class, options?): E

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

E

E extends Entity

Parameters

name

string

Class

() => E

options?

SpawnOptions

Returns

E

Inherited from

Entity.spawnChild

Call Signature

spawnChild<E, P>(name, Class, params, options?): E

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

E

E extends Entity

P

P

Parameters

name

string

Class

() => E & object

params

P

options?

SpawnOptions

Returns

E

Inherited from

Entity.spawnChild

Call Signature

spawnChild<P>(name, blueprint, params, options?): Entity

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

P

P

Parameters

name

string

blueprint

Blueprint<P>

params

P

options?

SpawnOptions

Returns

Entity

Inherited from

Entity.spawnChild

Call Signature

spawnChild(name, blueprint, options?): Entity

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Parameters

name

string

blueprint

Blueprint<void>

options?

SpawnOptions

Returns

Entity

Inherited from

Entity.spawnChild

tryGet()

tryGet<C>(cls): C | undefined

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

Get a component by class, or undefined if not found.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C | undefined

Inherited from

Entity.tryGet

tryGetChild()

tryGetChild(name): Entity | undefined

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

Get a child by name, or undefined if not found.

Parameters

name

string

Returns

Entity | undefined

Inherited from

Entity.tryGetChild

unfollow()

unfollow(): void

Defined in: renderer/src/CameraEntity.ts:172

Returns

void

worldToScreen()

worldToScreen(worldX, worldY): Vec2

Defined in: renderer/src/CameraEntity.ts:192

Parameters

worldX

number

worldY

number

Returns

Vec2

zoomTo()

zoomTo(target, duration, easing?): void

Defined in: renderer/src/CameraEntity.ts:184

Parameters

target

number

duration

number

easing?

EasingFunction

Returns

void