sm.camera.state

Camera states are used to specify how the camera will view the world. The default state is meant for normal gameplay and the scripted states are meant to be used in cutscenes or interactables.

Kind: Constant

Environments: Game

Game

Open the full Game reference

The states are:

  • default – The camera is controlled by the player.
  • cutsceneFP – Scripted first-person camera; position, rotation, and FOV are set by script.
  • cutsceneTP – Scripted third-person camera; position, rotation, and FOV are set by script.
  • forcedTP – Forces a third-person view regardless of the player's zoom step. Used during tumbling.
  • gyroSeatFP – First-person camera whose direction is driven by the gyro seat's rotation.
  • gyroSeatTP – Third-person camera for the gyro seat.
  • scriptedTP – Third-person camera with position, rotation, and FOV fully overridden by script. Used for interactable cutscenes.
  • seatLockedCamera – The camera direction and position are locked to the seat's local space. The view is first-person unless a pullback is set, which produces a third-person view.
Value Description
default 1
cutsceneFP 2
cutsceneTP 3
forcedTP 4
gyroSeatFP 5
gyroSeatTP 6
scriptedTP 7
seatLockedCamera 8

Returns:

Type Description
table