rojo/.cursor/rules/roblox/reference/engine/enums/CameraMode.yaml
2026-02-02 12:08:47 -06:00

48 lines
1.7 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: CameraMode
type: enum
summary: |
Used to set `Class.Player.CameraMode` to determine when first person and third
person cameras should be used.
description: |
The **CameraMode** enum is used to set `Class.Player.CameraMode` to determine
when first person and third person cameras should be used.
#### Third Person
In the default third person mode (`Enum.CameraMode|Classic`), the character
can be seen in the camera. While in this mode, the default behavior is:
- Players can right-click and drag (mouse), tap and drag (mobile), use the
secondary thumbstick (gamepad), or press the left/right arrows (keyboard) to
rotate the camera around their character.
- When a player moves their character, it faces in the corresponding movement
direction.
- Players can zoom in and out freely, even to first person on full zoom in.
#### First Person
In first person mode (`Enum.CameraMode|LockFirstPerson`), the player's camera
is zoomed all the way in. Unless there is a visible GUI present with the
`Class.GuiButton.Modal` property set to `true`, moving the mouse, tap-dragging
on mobile, or using the secondary thumbstick on a gamepad will rotate the
camera around the character.
code_samples: []
tags: []
deprecation_message: ''
items:
- name: Classic
summary: |
Third person camera which can be zoomed into first person.
value: 0
tags: []
deprecation_message: ''
- name: LockFirstPerson
summary: |
Exclusively first person camera.
value: 1
tags: []
deprecation_message: ''