Kiln API / kiln / CameraRigState

Class: CameraRigState

The camera rig's settings and state. Change settings with res.mut(CameraRig): offset from the focus point (3D default 0, 10, 12; 2D 0, 0, 100), smoothing (catch-up rate per second; 0 snaps), lookAt (3D: aim at the focus), bounds (clamp the focus), zoom, and shake tuning (maxOffset world units, maxAngle radians, decay trauma per second). shake(amount) adds trauma 0..1; the shake is trauma² so small hits stay subtle. focus is where the rig looks now.

Constructors

Constructor

new CameraRigState(is2D): CameraRigState;

Parameters

Parameter	Type
is2D	boolean

Returns

CameraRigState

Properties

enabled

enabled: boolean = true;

---

offset

offset: Vec;

---

smoothing

smoothing: number = 6;

---

lookAt

lookAt: boolean = true;

---

bounds

bounds: CameraBounds | null = null;

---

zoom

zoom: number = 1;

---

trauma

trauma: number = 0;

---

maxOffset

maxOffset: number;

---

maxAngle

maxAngle: number = 0.06;

---

decay

decay: number = 1.5;

---

frequency

frequency: number = 18;

Noise speed of the shake, in cycles per second.

---

focus

focus: Vec;

The smoothed point the camera follows. Set it to cut the camera somewhere.

---

started

started: boolean = false;

False until the first target is found; then the rig snaps to it once.

---

t

t: number = 0;

Seconds of shake noise elapsed.

---

current

readonly current: object;

The current shake offset and roll, for tests and for effects that want to match it.

x

x: number = 0;

y

y: number = 0;

z

z: number = 0;

roll

roll: number = 0;

---

is2D

readonly is2D: boolean;

Methods

shake()

shake(amount): void;

Adds trauma (0..1 total). 0.2 is a bump, 0.5 a hit, 1 an explosion.

Parameters

Parameter	Type
amount	number

Returns

void

---

snap()

snap(to?): void;

Jumps to the target (or to) next frame instead of easing there.

Parameters

Parameter	Type
to?	Partial<Vec>

Returns

void

---

toJSON()

toJSON(): object;

Returns

object

enabled

enabled: boolean;

offset

offset: Vec;

smoothing

smoothing: number;

lookAt

lookAt: boolean;

bounds

bounds: CameraBounds | null;

zoom

zoom: number;

trauma

trauma: number;

focus

focus: Vec;

---

restore()

restore(json): void;

Parameters

Parameter	Type
json	Partial<ReturnType<CameraRigState["toJSON"]>>

Returns

void