Transform

Defined in: Transform.ts:15

Mutable transform component for entity positioning.

Extends

Component

Constructors

Constructor

new Transform(options?): Transform

Defined in: Transform.ts:25

Parameters

options?

position?

Vec2Like

rotation?

number

scale?

Vec2Like

Returns

Transform

Overrides

Component.constructor

Properties

enabled

enabled: boolean = true

Defined in: Component.ts:22

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

Inherited from

Component.enabled

entity

entity: Entity

Defined in: Component.ts:19

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

context

Get Signature

get context(): EngineContext

Defined in: Component.ts:45

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

Returns

EngineContext

Inherited from

Component.context

position

Get Signature

get position(): Vec2

Defined in: Transform.ts:44

Local position (relative to parent, or world if no parent).

Returns

Vec2

Set Signature

set position(v): void

Defined in: Transform.ts:48

Parameters

v

Vec2

Returns

void

rotation

Get Signature

get rotation(): number

Defined in: Transform.ts:54

Local rotation in radians.

Returns

number

Set Signature

set rotation(v): void

Defined in: Transform.ts:58

Parameters

v

number

Returns

void

scale

Get Signature

get scale(): Vec2

Defined in: Transform.ts:64

Local scale factor.

Returns

Vec2

Set Signature

set scale(v): void

Defined in: Transform.ts:68

Parameters

v

Vec2

Returns

void

scene

Get Signature

get scene(): Scene

Defined in: Component.ts:31

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

ProcessComponent.scene

worldPosition

Get Signature

get worldPosition(): Vec2

Defined in: Transform.ts:74

Computed world position. Recomputed lazily when dirty.

Returns

Vec2

Set Signature

set worldPosition(v): void

Defined in: Transform.ts:80

Set position in world space. Back-computes the local position from the parent chain.

Parameters

v

Vec2

Returns

void

worldRotation

Get Signature

get worldRotation(): number

Defined in: Transform.ts:93

Computed world rotation. Recomputed lazily when dirty.

Returns

number

Set Signature

set worldRotation(v): void

Defined in: Transform.ts:99

Set rotation in world space. Back-computes the local rotation from the parent chain.

Parameters

v

number

Returns

void

worldScale

Get Signature

get worldScale(): Vec2

Defined in: Transform.ts:110

Computed world scale. Recomputed lazily when dirty.

Returns

Vec2

Methods

_markDirty()

_markDirty(): void

Defined in: Transform.ts:149

Internal

Mark this transform and all descendant transforms as dirty.

Returns

void

_runCleanups()

_runCleanups(): void

Defined in: Component.ts:140

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: Component.ts:130

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()?

optional afterRestore(data, resolve): void

Defined in: Component.ts:168

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: Component.ts:162

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: Component.ts:111

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: Component.ts:121

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

optional onAdd(): void

Defined in: Component.ts:150

Called when the component is added to an entity.

Returns

void

Inherited from

Component.onAdd

onDestroy()?

optional onDestroy(): void

Defined in: Component.ts:156

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

Returns

void

Inherited from

Component.onDestroy

onRemove()?

optional onRemove(): void

Defined in: Component.ts:153

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

rotate()

rotate(deltaRadians): void

Defined in: Transform.ts:134

Rotate by a delta in radians.

Parameters

deltaRadians

number

Returns

void

serialize()

serialize(): TransformData

Defined in: Transform.ts:178

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

Returns

TransformData

Overrides

Component.serialize

service()

protected service<T>(key): T

Defined in: Component.ts:67

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

setPosition()

setPosition(x, y): void

Defined in: Transform.ts:116

Set position directly.

Parameters

x

number

y

number

Returns

void

setRotation()

setRotation(radians): void

Defined in: Transform.ts:128

Set rotation in radians.

Parameters

radians

number

Returns

void

setScale()

setScale(x, y): void

Defined in: Transform.ts:140

Set scale.

Parameters

x

number

y

number

Returns

void

sibling()

protected sibling<C>(cls): C

Defined in: Component.ts:92

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

translate()

translate(dx, dy): void

Defined in: Transform.ts:122

Translate by an offset.

Parameters

dx

number

dy

number

Returns

void

update()?

optional update(dt): void

Defined in: Component.ts:159

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: Component.ts:50

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

Defined in: Transform.ts:186

Parameters

data

TransformData

Returns

Transform