Skip to content

Commit a4321fc

Browse files
committed
1 parent 0e78de8 commit a4321fc

95 files changed

Lines changed: 9756 additions & 101 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/scripting-reference/api.json‎

Lines changed: 9072 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: 'Sky'
3+
---
4+
# `constants` Sky <font size="4">(client-side)</font>
5+
6+
| Name | Description |
7+
| :----------: | :----------------------------------- |
8+
| `PLANET_SUN` | Represents planet sun type. |
9+
| `PLANET_MOON` | Represents planet moon type. |
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: 'onWeatherChange'
3+
---
4+
# `event` onWeatherChange <font size="4">(client-side)</font>
5+
!!! info "Available since version: 0.3.0"
6+
7+
Triggered when weather changes.
8+
9+
## Parameters
10+
```c++
11+
void onWeatherChange(int old_weather_type, int new_weather_type)
12+
```
13+
14+
* `int` **old_weather_type**: Previous weather type.
15+
* `int` **new_weather_type**: New weather type.

‎docs/scripting-reference/client-functions/cursor/setCursorPosition.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ Sets the cursor position in virtual (screen-scaled) coordinates.
88

99
## Declaration
1010
```cpp
11-
void setCursorPosition(int x, int y)
11+
bool setCursorPosition(int x, int y)
1212
```
1313
1414
## Parameters
1515
* `int` **x**: X position.
1616
* `int` **y**: Y position.
17+
18+
## Returns `bool`
19+
True on success.

‎docs/scripting-reference/client-functions/cursor/setCursorPositionPx.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ Sets the cursor position in pixel coordinates.
88

99
## Declaration
1010
```cpp
11-
void setCursorPositionPx(int x, int y)
11+
bool setCursorPositionPx(int x, int y)
1212
```
1313
1414
## Parameters
1515
* `int` **x**: X position in pixels.
1616
* `int` **y**: Y position in pixels.
17+
18+
## Returns `bool`
19+
True on success.

‎docs/scripting-reference/client-functions/cursor/setCursorSensitivity.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ Sets the cursor movement sensitivity.
88

99
## Declaration
1010
```cpp
11-
void setCursorSensitivity(number sensitivity)
11+
bool setCursorSensitivity(number sensitivity)
1212
```
1313
1414
## Parameters
1515
* `number` **sensitivity**: Cursor sensitivity multiplier.
16+
17+
## Returns `bool`
18+
True on success.

‎docs/scripting-reference/client-functions/cursor/setCursorSize.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ Sets the cursor size in virtual (screen-scaled) units.
88

99
## Declaration
1010
```cpp
11-
void setCursorSize(int width, int height)
11+
bool setCursorSize(int width, int height)
1212
```
1313
1414
## Parameters
1515
* `int` **width**: Cursor width.
1616
* `int` **height**: Cursor height.
17+
18+
## Returns `bool`
19+
True on success.

‎docs/scripting-reference/client-functions/cursor/setCursorSizePx.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ Sets the cursor size in pixel units.
88

99
## Declaration
1010
```cpp
11-
void setCursorSizePx(int width, int height)
11+
bool setCursorSizePx(int width, int height)
1212
```
1313
1414
## Parameters
1515
* `int` **width**: Cursor width in pixels.
1616
* `int` **height**: Cursor height in pixels.
17+
18+
## Returns `bool`
19+
True on success.

‎docs/scripting-reference/client-functions/cursor/setCursorTxt.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ Sets the cursor texture.
88

99
## Declaration
1010
```cpp
11-
void setCursorTxt(string file)
11+
bool setCursorTxt(string file)
1212
```
1313
1414
## Parameters
1515
* `string` **file**: Texture file name.
16+
17+
## Returns `bool`
18+
True on success.

‎docs/scripting-reference/client-functions/cursor/setCursorVisible.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ Sets whether the cursor is visible.
88

99
## Declaration
1010
```cpp
11-
void setCursorVisible(bool toggle)
11+
bool setCursorVisible(bool toggle)
1212
```
1313
1414
## Parameters
1515
* `bool` **toggle**: True to show the cursor, false to hide it.
16+
17+
## Returns `bool`
18+
True on success.

0 commit comments

Comments
 (0)