Skip to content

RotateComp

Defined in: packages/threeplay/src/plugins/transform/types.ts:40

Fields added by rotate(). Angles are in degrees.

optional add(this): void

Defined in: packages/threeplay/src/core/types.ts:63

Called when the object enters the scene (or when used on a live object).

GameObj

void

Comp.add


optional destroy(this): void

Defined in: packages/threeplay/src/core/types.ts:69

Called when the object is destroyed or the component removed.

GameObj

void

Comp.destroy


optional fixedUpdate(this): void

Defined in: packages/threeplay/src/core/types.ts:67

Called at the fixed physics rate (50 Hz by default).

GameObj

void

Comp.fixedUpdate


forward(): Vector3

Defined in: packages/threeplay/src/plugins/transform/types.ts:55

Unit vector the object faces (local -Z in world space).

Vector3


optional inspect(this): string | null | undefined

Defined in: packages/threeplay/src/core/types.ts:71

Short status line shown by the debug inspector.

GameObj

string | null | undefined

Comp.inspect


lookAt(target): void

Defined in: packages/threeplay/src/plugins/transform/types.ts:53

Turns the object to face a point or object (Y-up).

PosTarget

void


right(): Vector3

Defined in: packages/threeplay/src/plugins/transform/types.ts:57

Unit vector to the object’s right (local +X in world space).

Vector3


rotateBy(x, y?, z?): void

Defined in: packages/threeplay/src/plugins/transform/types.ts:51

Adds degrees to the rotation.

number

number

number

void


optional update(this): void

Defined in: packages/threeplay/src/core/types.ts:65

Called once per frame.

GameObj

void

Comp.update

optional conflicts?: string[]

Defined in: packages/threeplay/src/core/types.ts:61

Ids of components that can’t be on the same object (checked both ways).

Comp.conflicts


id: "rotate"

Defined in: packages/threeplay/src/plugins/transform/types.ts:41

Unique name. Two components with the same id replace each other.

Comp.id


optional require?: string[]

Defined in: packages/threeplay/src/core/types.ts:59

Ids of components that must be present on the object.

Comp.require


rot: Vector3

Defined in: packages/threeplay/src/plugins/transform/types.ts:43

Euler rotation in degrees (X, Y, Z), applied to object3d every frame.


rotOrder: EulerOrder

Defined in: packages/threeplay/src/plugins/transform/types.ts:49

Order in which the rot angles apply (default "XYZ", three’s). Vehicles and aircraft want "YXZ": heading (Y), then pitch (X), then roll (Z), so rolling never changes the heading.