NoClipState
Defined in: client/api.d.ts:1915
Where the free camera is and what it is doing.
Properties
Section titled “Properties”aspectRatio
Section titled “aspectRatio”aspectRatio:
number
Defined in: client/api.d.ts:1974
Width over height, as the renderer reports it.
forward
Section titled “forward”forward:
Vector3
Defined in: client/api.d.ts:1934
The unit direction it is looking along.
fov:
number
Defined in: client/api.d.ts:1964
The vertical field of view in degrees the view was asked for.
input:
boolean
Defined in: client/api.d.ts:1924
Whether this machine’s own keyboard and mouse are flying the camera.
mode:
"body"|"camera"
Defined in: client/api.d.ts:1919
Whether the player’s body is carried through the world or left behind.
pitch:
number
Defined in: client/api.d.ts:1954
Its elevation in degrees, clamped to -89..89. Positive looks up.
position
Section titled “position”position:
Vector3
Defined in: client/api.d.ts:1929
Where the camera is, in world-space metres.
renderedFov
Section titled “renderedFov”renderedFov:
number
Defined in: client/api.d.ts:1969
The vertical field of view the renderer settled on, which Hor+ adaptation and the window’s aspect both move.
right:
Vector3
Defined in: client/api.d.ts:1939
The unit direction to its right, level with the horizon.
speed:
number
Defined in: client/api.d.ts:1959
Metres a second at rest, before boost or crawl scales it.
up:
Vector3
Defined in: client/api.d.ts:1944
The unit direction out of the top of the frame.
yaw:
number
Defined in: client/api.d.ts:1949
Its heading in degrees, wrapped to -180..180. Zero faces +Y and a rising yaw swings left.