Skip to content

Camera ​

@vimp-mp/types 2.0.1

Interface · Client API

Scripted or gameplay camera exposed by the client runtime.

ts
interface Camera

Members ​

direction ​

ts
readonly direction: Vec3

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

fov ​

ts
readonly fov: number

Current field of view in degrees.

handle ​

ts
readonly handle: number

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

id ​

ts
readonly id: number

Client-local camera identifier.

isActive ​

ts
readonly isActive: boolean

Whether the scripted camera is active.

isAlive ​

ts
readonly isAlive: boolean

Whether the camera can still be used.

isGameplay ​

ts
readonly isGameplay: boolean

Whether this wrapper represents the gameplay camera.

name ​

ts
readonly name: string

GTA camera type name used at creation.

position ​

ts
readonly position: Vec3

Current world position.

rotation ​

ts
readonly rotation: Vec3

Current camera rotation in degrees.

destroy ​

ts
destroy(): void

Destroys this camera instance.

pointAtCoord ​

ts
pointAtCoord(position: Vec3): void

Points the camera at a world coordinate.

setActive ​

ts
setActive(active: boolean): void

Activates or deactivates this scripted camera.

setFov ​

ts
setFov(fov: number): void

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

setPosition ​

ts
setPosition(position: Vec3): void

Moves the scripted camera to a world position.

setRotation ​

ts
setRotation(rotation: Vec3): void

Changes the scripted camera's rotation in degrees.

VIMP developer documentation