Camera

const Camera: object

Defined in: client/api.d.ts:658

Client control of the local game camera: projecting world positions through it, and driving a scripted view on its own camera layer.

Type Declaration

interpolate()

interpolate(x, y, z, lookX, lookY, lookZ, durationSeconds): void

Smoothly moves the camera from its current view to a fixed destination until reset is called.

Parameters

x

number

Destination camera world-space X coordinate.

y

number

Destination camera world-space Y coordinate.

z

number

Destination camera world-space Z coordinate.

lookX

number

Destination world-space look-at X coordinate.

lookY

number

Destination world-space look-at Y coordinate.

lookZ

number

Destination world-space look-at Z coordinate.

durationSeconds

number

Transition duration in seconds; zero or less cuts.

Returns

void

isScripted()

isScripted(): boolean

Checks whether a scripted camera view is currently held.

Returns

boolean

True while setPosition or interpolate owns the camera.

reset()

reset(): void

Returns control to the normal gameplay camera.

Returns

void

setPosition()

setPosition(x, y, z, lookX, lookY, lookZ): void

Cuts the camera to a fixed position and look-at target until reset is called. Streaming stays pinned to the player while a scripted view is active.

Parameters

x

number

Camera world-space X coordinate.

y

number

Camera world-space Y coordinate.

z

number

Camera world-space Z coordinate.

lookX

number

World-space X coordinate the camera looks at.

lookY

number

World-space Y coordinate the camera looks at.

lookZ

number

World-space Z coordinate the camera looks at.

Returns

void

worldToScreen()

worldToScreen(x, y, z): ScreenPosition

Projects a world-space position to display pixel coordinates.

Parameters

x

number

World X coordinate.

y

number

World Y coordinate.

z

number

World Z coordinate.

Returns

ScreenPosition

Screen coordinates and whether the point is visible through the active camera.

Example

const point = Camera.worldToScreen(10, 20, 5);
if (point.visible) {
  // point.x and point.y are display pixels.
}