Skip to content

Commit a6e5441

Browse files
committed
1 parent 38d31a9 commit a6e5441

28 files changed

Lines changed: 348 additions & 720 deletions

‎docs/api.json‎

Lines changed: 135 additions & 382 deletions
Large diffs are not rendered by default.

‎docs/scripting-reference/client-classes/game/Camera.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Represents whether scripted camera mode changes are enabled.
1616
### `boolean` movementEnabled
1717

1818
Represents whether the camera is allowed to move.
19+
Setting this to true restores engine camera AI after manual position or rotation changes.
1920

2021
----
2122
### `Vob|nil` targetVob
@@ -59,6 +60,7 @@ Camera mode name.
5960
### setPosition
6061

6162
Sets the active camera world position.
63+
This puts the camera into manual movement mode until movementEnabled is set to true.
6264

6365
```cpp
6466
void setPosition(number x, number y, number z)
@@ -89,6 +91,7 @@ Table containing x,y,z world position.
8991
### setRotation
9092

9193
Sets the active camera Euler rotation.
94+
This puts the camera into manual movement mode until movementEnabled is set to true.
9295

9396
```cpp
9497
void setRotation(number x, number y, number z)
@@ -135,7 +138,7 @@ True if the target was applied.
135138
----
136139
### setTargetPlayer
137140
138-
Sets a player NPC as the active camera target.
141+
Sets a player or NPC as the active camera target.
139142
140143
```cpp
141144
boolean setTargetPlayer(number playerId)
@@ -147,7 +150,7 @@ boolean setTargetPlayer(number playerId)
147150

148151
**Returns `boolean`:**
149152

150-
True if the player exists and has an NPC.
153+
True if the player or NPC exists.
151154

152155
----
153156
### setFOV
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: 'Sky'
3+
---
4+
# `class` Sky <font size="4">(client-side)</font>
5+
!!! info "Available since version: 0.3.0"
6+
7+
Static sky controller for local and synchronized sky settings.
8+
9+
10+
## Properties
11+
### `number` weatherType
12+
13+
Current local weather type. Use `refresh()` to pull the authoritative value from the server.
14+
15+
----
16+
### `{hour = number, min = number}` rainStartTime
17+
18+
Rain start time.
19+
20+
----
21+
### `{hour = number, min = number}` rainStopTime
22+
23+
Rain stop time.
24+
25+
----
26+
### `number` windScale
27+
28+
Wind scale used during precipitation.
29+
30+
----
31+
### `boolean` dontRain
32+
33+
Toggles local rain and snow rendering.
34+
35+
----
36+
### `{id = number, r = number, g = number, b = number}` fogColor
37+
38+
Write-only fog color table.
39+
40+
----
41+
### `{r = number, g = number, b = number}` cloudsColor
42+
43+
Write-only cloud color table.
44+
45+
----
46+
### `{planetId = number, size = number}` planetSize
47+
48+
Write-only planet size table.
49+
50+
----
51+
### `{planetId = number, r = number, g = number, b = number, a = number}` planetColor
52+
53+
Write-only planet color table.
54+
55+
----
56+
### `{planetId = number, texture = string}` planetTxt
57+
58+
Write-only planet texture table.
59+
60+
----
61+
### `{r = number, g = number, b = number}` lightingColor
62+
63+
Write-only lighting color table.
64+
65+
----
66+
67+
## Methods
68+
### refresh
69+
70+
Requests authoritative time and sky settings from the server and applies them when the reply arrives.
71+
72+
```cpp
73+
boolean refresh()
74+
```
75+
76+
77+
**Returns `boolean`:**
78+
79+
True if the refresh request was sent.
80+
81+
----
82+
83+
## Callbacks
84+
No callbacks.
85+
86+
----

‎docs/scripting-reference/client-functions/sky/setCloudsColor.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/scripting-reference/client-functions/sky/setFogColor.md‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎docs/scripting-reference/client-functions/sky/setLightingColor.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/scripting-reference/client-functions/sky/setPlanetColor.md‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎docs/scripting-reference/client-functions/sky/setPlanetSize.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/scripting-reference/client-functions/sky/setPlanetTxt.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/scripting-reference/client-functions/weather/getRainStartTime.md‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)