Camera

Camera functions.

Field
Returns
Readonly
Description

IsManual

bool

true

Is camera in manual mode.

Position

Vector3

true

Current camera position.

Rotation

Vector3

true

Current camera rotation.

Velocity

Vector3

true

Current camera velocity, if set using SetVelocity().

FOV

float

true

Current camera field of view if set using SetFOV().

FollowDistance

float

false

Current camera follow distance from target character.

Forward

Vector3

false

The forward direction of the camera.

Right

Vector3

false

The right direction of the camera.

Up

Vector3

false

The up direction of the camera.

CameraMode

String

true

The camera mode.

Function
Returns
Description

SetManual(bool)

null

Sets the camera manual mode. If true, camera will only be controlled by custom logic. If false, camera will follow the spawned or spectated player and read input.

SetPosition(position: Vector3)

null

Sets camera position.

SetRotation(rotation: Vector3)

null

Sets camera rotation.

SetVelocity(rotation: Vector3)

null

Sets camera velocity.

LookAt(position: Vector3)

null

Sets the camera forward direction such that it is looking at a world position.

SetFOV(fov: float)

null

Sets the camera field of view. Use 0 to use the default field of view.

SetCameraMode(mode: string)

null

Forces the player to use a certain camera mode, taking priority over their camera setting. Accepted values are TPS, Original, FPS.

ResetDistance()

null

Resets the follow distance to player's settings.

ResetCameraMode()

null

Resets the camera mode to player's settings.

Last updated