CameraComponent

Defined in: renderer/src/CameraComponent.ts:87

Core camera state component. Added by CameraEntity; holds position, zoom, rotation, and layer bindings. Provides convenience methods that delegate to sibling behavior components (CameraFollow, CameraShake, etc.).

Added by CameraEntity; access via direct reference from spawn() or by querying entities with this component.

Extends

Component

Constructors

Constructor

new CameraComponent(options?): CameraComponent

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

Parameters

options?

CameraComponentOptions

Returns

CameraComponent

Overrides

Component.constructor

Properties

bindings

readonly bindings: CameraBinding[] | null

Defined in: renderer/src/CameraComponent.ts:92

cameraName

readonly cameraName: string | undefined

Defined in: renderer/src/CameraComponent.ts:94

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

position

position: Vec2

Defined in: renderer/src/CameraComponent.ts:88

priority

readonly priority: number

Defined in: renderer/src/CameraComponent.ts:93

rotation

rotation: number

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

zoom

zoom: number

Defined in: renderer/src/CameraComponent.ts:89

Accessors

bounds

Get Signature

get bounds(): CameraBounds | undefined

Defined in: renderer/src/CameraComponent.ts:145

Get or set camera bounds.

Returns

CameraBounds | undefined

Set Signature

set bounds(value): void

Defined in: renderer/src/CameraComponent.ts:149

Parameters

value

CameraBounds | undefined

Returns

void

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

effectivePosition

Get Signature

get effectivePosition(): Vec2

Defined in: renderer/src/CameraComponent.ts:115

Effective position including shake offset.

Returns

Vec2

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

viewportHeight

Get Signature

get viewportHeight(): number

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

Returns

number

viewportWidth

Get Signature

get viewportWidth(): number

Defined in: renderer/src/CameraComponent.ts:106

Returns

number

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()?

optional afterRestore(data, resolve): void

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

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

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

follow()

follow(target, options?): void

Defined in: renderer/src/CameraComponent.ts:121

Start following a target.

Parameters

target

position

Vec2Like

options?

CameraFollowOptions

Returns

void

getResolvedBindings()

getResolvedBindings(tree): readonly CameraBinding[]

Defined in: renderer/src/CameraComponent.ts:187

Resolve bindings for this camera against the given render tree.

If no explicit bindings were passed, auto-binds every world-space layer (LayerDef.space === "world", the default). Screen-space layers — declared with space: "screen" or auto-provisioned by plugins via ensureLayer(def, { space: "screen" }), e.g. the UI layer — are skipped so they stay fixed to the viewport. Cameras can still explicitly bind a screen-space layer by naming it in bindings.

Parameters

tree

SceneRenderTree

Returns

readonly CameraBinding[]

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()?

optional onAdd(): void

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

Called when the component is added to an entity.

Returns

void

Inherited from

Component.onAdd

onDestroy()?

optional onDestroy(): void

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

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

Returns

void

Inherited from

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

screenToWorld()

screenToWorld(screenX, screenY): Vec2

Defined in: renderer/src/CameraComponent.ts:154

Convert screen coordinates to world coordinates.

Parameters

screenX

number

screenY

number

Returns

Vec2

serialize()

serialize(): CameraComponentData

Defined in: renderer/src/CameraComponent.ts:195

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

Returns

CameraComponentData

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

shake()

shake(intensity, duration, options?): void

Defined in: renderer/src/CameraComponent.ts:131

Start a screen shake effect.

Parameters

intensity

number

duration

number

options?

CameraShakeOptions

Returns

void

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

unfollow()

unfollow(): void

Defined in: renderer/src/CameraComponent.ts:126

Stop following any target.

Returns

void

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

worldToScreen()

worldToScreen(worldX, worldY): Vec2

Defined in: renderer/src/CameraComponent.ts:166

Convert world coordinates to screen coordinates.

Parameters

worldX

number

worldY

number

Returns

Vec2

zoomTo()

zoomTo(target, duration, easing?): void

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

Animate zoom to a target value over a duration.

Parameters

target

number

duration

number

easing?

EasingFunction

Returns

void

fromSnapshot()

static fromSnapshot(data): CameraComponent

Defined in: renderer/src/CameraComponent.ts:209

Parameters

data

CameraComponentData

Returns

CameraComponent