Skip to content

Commit e034f7b

Browse files
committed
1 parent 663a11a commit e034f7b

256 files changed

Lines changed: 2186 additions & 1387 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/api.json

Lines changed: 914 additions & 518 deletions
Large diffs are not rendered by default.

docs/scripting-reference/client-classes/game/Sound.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Sound.new(string file)
2121
Get or set the sound file path.
2222

2323
----
24-
### `float` playingTime <font size="2">(read-only)</font>
24+
### `number` playingTime <font size="2">(read-only)</font>
2525

2626
Return the current playback time.
2727

2828
----
29-
### `float` volume
29+
### `number` volume
3030

3131
Get or set the playback volume.
3232

@@ -36,7 +36,7 @@ Get or set the playback volume.
3636
Get or set whether the sound should loop.
3737

3838
----
39-
### `float` balance
39+
### `number` balance
4040

4141
Get or set the stereo balance (pan).
4242

docs/scripting-reference/client-classes/game/Vob.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Represents the state of dynamic collision of vob. Enabling this option will prev
4242
Represents the state of static collision of vob. Enabling this option will prevent static objects (i.e. world mesh) from passing through it.
4343

4444
----
45-
### `float` farClipZScale
45+
### `number` farClipZScale
4646

4747
Represents the max distance at which the vob will still be rendered.
4848

@@ -52,7 +52,7 @@ Represents the max distance at which the vob will still be rendered.
5252
Represents the model file name used as vob visual, e.g. SPHERE.3DS.
5353

5454
----
55-
### `float` visualAlpha
55+
### `number` visualAlpha
5656

5757
Represents the transparency of the vob visual.
5858

@@ -64,14 +64,14 @@ Represents the transparency of the vob visual.
6464
Set the position of the vob in the world.
6565

6666
```cpp
67-
void setPosition(float x, float y, float z)
67+
void setPosition(number x, number y, number z)
6868
```
6969
7070
**Parameters:**
7171
72-
* `float` **x**: Position on X axis.
73-
* `float` **y**: Position on Y axis.
74-
* `float` **z**: Position on Z axis.
72+
* `number` **x**: Position on X axis.
73+
* `number` **y**: Position on Y axis.
74+
* `number` **z**: Position on Z axis.
7575
7676
7777
----
@@ -94,14 +94,14 @@ Get the position of the vob in the world.
9494
Set the euler rotation of the vob in the world.
9595

9696
```cpp
97-
void setRotation(float x, float y, float z)
97+
void setRotation(number x, number y, number z)
9898
```
9999
100100
**Parameters:**
101101
102-
* `float` **x**: Rotation on X axis.
103-
* `float` **y**: Rotation on Y axis.
104-
* `float` **z**: Rotation on Z axis.
102+
* `number` **x**: Rotation on X axis.
103+
* `number` **y**: Rotation on Y axis.
104+
* `number` **z**: Rotation on Z axis.
105105
106106
107107
----

docs/scripting-reference/client-classes/ui/Draw.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Draw.new()
1616
No parameters.
1717
### Constructor
1818
```cpp
19-
Draw.new(int x, int y, string text)
19+
Draw.new(number x, number y, string text)
2020
```
2121

2222
**Parameters:**
2323

24-
* `int` **x**: Initial X position (virtual units).
25-
* `int` **y**: Initial Y position (virtual units).
24+
* `number` **x**: Initial X position (virtual units).
25+
* `number` **y**: Initial Y position (virtual units).
2626
* `string` **text**: Initial text content.
2727

2828
## Properties
@@ -51,7 +51,7 @@ Gets or sets the font identifier used for rendering.
5151
Returns the current text color.
5252

5353
----
54-
### `int` alpha
54+
### `number` alpha
5555

5656
Gets or sets the alpha (opacity).
5757

@@ -68,13 +68,13 @@ Gets or sets whether the Draw object is rendered.
6868
Sets the draw position in virtual screen units.
6969

7070
```cpp
71-
void setPosition(int x, int y)
71+
void setPosition(number x, number y)
7272
```
7373
7474
**Parameters:**
7575
76-
* `int` **x**: X position (virtual units).
77-
* `int` **y**: Y position (virtual units).
76+
* `number` **x**: X position (virtual units).
77+
* `number` **y**: Y position (virtual units).
7878
7979
8080
----
@@ -97,13 +97,13 @@ Table containing x and y (virtual units).
9797
Sets the draw position in pixel coordinates.
9898

9999
```cpp
100-
void setPositionPx(int x, int y)
100+
void setPositionPx(number x, number y)
101101
```
102102
103103
**Parameters:**
104104
105-
* `int` **x**: X position in pixels.
106-
* `int` **y**: Y position in pixels.
105+
* `number` **x**: X position in pixels.
106+
* `number` **y**: Y position in pixels.
107107
108108
109109
----
@@ -182,14 +182,14 @@ Font file name.
182182
Sets the text color.
183183

184184
```cpp
185-
void setColor(int r, int g, int b)
185+
void setColor(number r, number g, number b)
186186
```
187187
188188
**Parameters:**
189189
190-
* `int` **r**: Red component (0-255).
191-
* `int` **g**: Green component (0-255).
192-
* `int` **b**: Blue component (0-255).
190+
* `number` **r**: Red component (0-255).
191+
* `number` **g**: Green component (0-255).
192+
* `number` **b**: Blue component (0-255).
193193
194194
195195
----
@@ -212,12 +212,12 @@ Table containing r,g,b (0-255).
212212
Sets text alpha (opacity).
213213

214214
```cpp
215-
void setAlpha(int alpha)
215+
void setAlpha(number alpha)
216216
```
217217
218218
**Parameters:**
219219
220-
* `int` **alpha**: Opacity value (0-255).
220+
* `number` **alpha**: Opacity value (0-255).
221221
222222
223223
----
@@ -226,11 +226,11 @@ void setAlpha(int alpha)
226226
Returns the current alpha (opacity).
227227
228228
```cpp
229-
int getAlpha()
229+
number getAlpha()
230230
```
231231

232232

233-
**Returns `int`:**
233+
**Returns `number`:**
234234

235235
Opacity value (0-255).
236236

docs/scripting-reference/client-classes/ui/Texture.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ title: 'Texture'
88

99
### Constructor
1010
```cpp
11-
Texture.new(int x, int y, int width, int height, string file)
11+
Texture.new(number x, number y, number width, number height, string file)
1212
```
1313

1414
**Parameters:**
1515

16-
* `int` **x**: X position (virtual units).
17-
* `int` **y**: Y position (virtual units).
18-
* `int` **width**: Width (virtual units).
19-
* `int` **height**: Height (virtual units).
16+
* `number` **x**: X position (virtual units).
17+
* `number` **y**: Y position (virtual units).
18+
* `number` **width**: Width (virtual units).
19+
* `number` **height**: Height (virtual units).
2020
* `string` **file**: Texture file path.
2121

2222
## Properties
@@ -55,7 +55,7 @@ Gets or sets the texture rectangle in pixel coordinates.
5555
Gets or sets the texture color.
5656

5757
----
58-
### `int` alpha
58+
### `number` alpha
5959

6060
Gets or sets the texture alpha (opacity).
6161

@@ -77,13 +77,13 @@ Gets or sets the texture file path.
7777
Sets the texture position in virtual screen units.
7878

7979
```cpp
80-
void setPosition(int x, int y)
80+
void setPosition(number x, number y)
8181
```
8282
8383
**Parameters:**
8484
85-
* `int` **x**: X position (virtual units).
86-
* `int` **y**: Y position (virtual units).
85+
* `number` **x**: X position (virtual units).
86+
* `number` **y**: Y position (virtual units).
8787
8888
8989
----
@@ -106,13 +106,13 @@ Table containing x and y (virtual units).
106106
Sets the texture position in pixel coordinates.
107107

108108
```cpp
109-
void setPositionPx(int x, int y)
109+
void setPositionPx(number x, number y)
110110
```
111111
112112
**Parameters:**
113113
114-
* `int` **x**: X position (pixels).
115-
* `int` **y**: Y position (pixels).
114+
* `number` **x**: X position (pixels).
115+
* `number` **y**: Y position (pixels).
116116
117117
118118
----
@@ -135,13 +135,13 @@ Table containing x and y (pixels).
135135
Sets the texture size in virtual screen units.
136136

137137
```cpp
138-
void setSize(int width, int height)
138+
void setSize(number width, number height)
139139
```
140140
141141
**Parameters:**
142142
143-
* `int` **width**: Width (virtual units).
144-
* `int` **height**: Height (virtual units).
143+
* `number` **width**: Width (virtual units).
144+
* `number` **height**: Height (virtual units).
145145
146146
147147
----
@@ -164,13 +164,13 @@ Table containing width and height (virtual units).
164164
Sets the texture size in pixel coordinates.
165165

166166
```cpp
167-
void setSizePx(int width, int height)
167+
void setSizePx(number width, number height)
168168
```
169169
170170
**Parameters:**
171171
172-
* `int` **width**: Width (pixels).
173-
* `int` **height**: Height (pixels).
172+
* `number` **width**: Width (pixels).
173+
* `number` **height**: Height (pixels).
174174
175175
176176
----
@@ -193,15 +193,15 @@ Table containing width and height (pixels).
193193
Sets the texture rectangle in virtual screen units.
194194

195195
```cpp
196-
void setRect(int x, int y, int width, int height)
196+
void setRect(number x, number y, number width, number height)
197197
```
198198
199199
**Parameters:**
200200
201-
* `int` **x**: X position (virtual units).
202-
* `int` **y**: Y position (virtual units).
203-
* `int` **width**: Width (virtual units).
204-
* `int` **height**: Height (virtual units).
201+
* `number` **x**: X position (virtual units).
202+
* `number` **y**: Y position (virtual units).
203+
* `number` **width**: Width (virtual units).
204+
* `number` **height**: Height (virtual units).
205205
206206
207207
----
@@ -224,15 +224,15 @@ Table containing x,y,width,height (virtual units).
224224
Sets the texture rectangle in pixel coordinates.
225225

226226
```cpp
227-
void setRectPx(int x, int y, int width, int height)
227+
void setRectPx(number x, number y, number width, number height)
228228
```
229229
230230
**Parameters:**
231231
232-
* `int` **x**: X position (pixels).
233-
* `int` **y**: Y position (pixels).
234-
* `int` **width**: Width (pixels).
235-
* `int` **height**: Height (pixels).
232+
* `number` **x**: X position (pixels).
233+
* `number` **y**: Y position (pixels).
234+
* `number` **width**: Width (pixels).
235+
* `number` **height**: Height (pixels).
236236
237237
238238
----
@@ -255,14 +255,14 @@ Table containing x,y,width,height (pixels).
255255
Sets the texture color.
256256

257257
```cpp
258-
void setColor(int r, int g, int b)
258+
void setColor(number r, number g, number b)
259259
```
260260
261261
**Parameters:**
262262
263-
* `int` **r**: Red component (0-255).
264-
* `int` **g**: Green component (0-255).
265-
* `int` **b**: Blue component (0-255).
263+
* `number` **r**: Red component (0-255).
264+
* `number` **g**: Green component (0-255).
265+
* `number` **b**: Blue component (0-255).
266266
267267
268268
----
@@ -285,12 +285,12 @@ Table containing r,g,b (0-255).
285285
Sets the texture alpha (opacity).
286286

287287
```cpp
288-
void setAlpha(int alpha)
288+
void setAlpha(number alpha)
289289
```
290290
291291
**Parameters:**
292292
293-
* `int` **alpha**: Opacity value (0-255).
293+
* `number` **alpha**: Opacity value (0-255).
294294
295295
296296
----
@@ -299,11 +299,11 @@ void setAlpha(int alpha)
299299
Returns the texture alpha (opacity).
300300
301301
```cpp
302-
int getAlpha()
302+
number getAlpha()
303303
```
304304

305305

306-
**Returns `int`:**
306+
**Returns `number`:**
307307

308308
Opacity value (0-255).
309309

docs/scripting-reference/client-events/game/onTime.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Triggered each time the game time minute passes.
88

99
## Parameters
1010
```c++
11-
void onTime(int day, int hour, int min)
11+
void onTime(number day, number hour, number min)
1212
```
1313
14-
* `int` **day**: The current in-game day.
15-
* `int` **hour**: The current in-game hour.
16-
* `int` **min**: The current in-game minute.
14+
* `number` **day**: The current in-game day.
15+
* `number` **hour**: The current in-game hour.
16+
* `number` **min**: The current in-game minute.

0 commit comments

Comments
 (0)