Camera

@vimp-mp/types 2.0.1

Interface · Client API

Scripted or gameplay camera exposed by the client runtime.

interface Camera

Members

direction

readonly direction: Vec3

Direction vector derived from rotation using GTA camera rotation order 2.

fov

readonly fov: number

Current field of view in degrees.

handle

readonly handle: number

GTA camera handle. Gameplay camera exposes 0 because it has no script handle.

id

readonly id: number

Client-local camera identifier.

isActive

readonly isActive: boolean

Whether the scripted camera is active.

isAlive

readonly isAlive: boolean

Whether the camera can still be used.

isGameplay

readonly isGameplay: boolean

Whether this wrapper represents the gameplay camera.

name

readonly name: string

GTA camera type name used at creation.

position

readonly position: Vec3

Current world position.

rotation

readonly rotation: Vec3

Current camera rotation in degrees.

destroy

destroy(): void

Destroys this camera instance.

pointAtCoord

pointAtCoord(position: Vec3): void

Points the camera at a world coordinate.

setActive

setActive(active: boolean): void

Activates or deactivates this scripted camera.

setFov

setFov(fov: number): void

Changes the scripted camera's field of view in degrees.

setPosition

setPosition(position: Vec3): void

Moves the scripted camera to a world position.

setRotation

setRotation(rotation: Vec3): void

Changes the scripted camera's rotation in degrees.