Camera API
Control camera position, rotation, and viewport.
Functions
x, y, z
camera:x() -> number
camera:y() -> number
camera:z() -> number
Get camera position coordinates.
Returns:
number- Position value
yaw
camera:yaw() -> number
Get camera yaw (rotation around vertical axis).
Returns:
number- Yaw value
yaw_angle
camera:yaw_angle() -> number
Get yaw in degrees (0-360).
Returns:
number- Yaw in degrees
pitch
camera:pitch() -> number
Get camera pitch (up/down angle).
Returns:
number- Pitch value
pitch_percent
camera:pitch_percent() -> number
Get pitch as percentage (0-100).
Returns:
number- Pitch percentage
zoom
camera:zoom() -> number
Get zoom level.
Returns:
number- Zoom value
zoom_percent
camera:zoom_percent() -> number
Get zoom as percentage.
Returns:
number- Zoom percentage
angle_to
camera:angle_to(degrees: number) -> number
Calculate angle difference to target degrees.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
degrees | number | Yes | Target angle |
Returns:
number- Angle difference
angle_cardinal
camera:angle_cardinal(direction: string) -> boolean
Turn to cardinal direction.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
direction | string | Yes | "n", "s", "e", "w" |
Returns:
boolean- True if successful
Example:
camera:angle_cardinal("n") -- Face north
angle_degrees
camera:angle_degrees(degrees: number) -> boolean
Turn to specific degrees.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
degrees | number | Yes | Target angle |
Returns:
boolean- True if successful
turn_to
camera:turn_to(entity: Player|NPC|GameObject) -> boolean
Turn camera to face entity.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
entity | any | Yes | - Entity to face |
Returns:
boolean- True if successful
Example:
local npc = npcs:find_first({name = "Guard"})
if npc then
camera:turn_to(npc)
end
turn_to_exact
camera:turn_to_exact(yaw: number, pitch: number) -> boolean
Turn to exact yaw and pitch.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
yaw | number | Yes | Target yaw |
pitch | number | Yes | Target pitch |
Returns:
boolean- True if successful
set_pitch_percent
camera:set_pitch_percent(percent: number) -> boolean
Set pitch to percentage.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
percent | number | Yes | Pitch percentage (0-100) |
Returns:
boolean- True if successful
pitch_to
camera:pitch_to(up: boolean) -> boolean
Pitch camera up or down.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
up | boolean | Yes | True for up, false for down |
Returns:
boolean- True if successful
reset
camera:reset() -> boolean
Reset to default position.
Returns:
boolean- True if successful
is_north
camera:is_north() -> boolean
Check if facing north.
Returns:
boolean- True if facing north
Related APIs
- Movement API - Player movement
- Game API - Game client state