Skip to content

Commit 1720dc7

Browse files
PlextoraPlextora
committed
Update docs
1 parent 303196e commit 1720dc7

File tree

158 files changed

+1624
-1268
lines changed

Some content is hidden

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

158 files changed

+1624
-1268
lines changed

‎definitions/game.d.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,16 @@ interface Game {
6969
*/
7070
getMousePos(): Vector2;
7171

72+
/**
73+
* Captures the mouse cursor (hides it and allows the player to look around using the mouse cursor.)
74+
*/
75+
captureCursor(): void;
76+
77+
/**
78+
* Releases the mouse cursor.
79+
*/
80+
releaseCursor(): void;
81+
7282
/**
7383
* Gets the user's input setting. Usually a key code; for example, `"forward"` returns `KeyCode.W` by default.
7484
*

‎definitions/gfx/graphics.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ declare interface Graphics {
115115
* @param renderer `"dx"`: uses Direct2D/DirectWrite, `"minecraft":` use the Minecraft renderer
116116
*/
117117
use(renderer: "dx" | "minecraft"): void;
118-
drawRect(rect: Rect, color: Color, thickness: number): void;
119-
fillRect(rect: Rect, color: Color): void;
118+
drawRect(rect: Rect, color: Color, thickness: number, radius?: number): void;
119+
fillRect(rect: Rect, color: Color, radius?: number): void;
120120

121121
getTextSize(text: string, textSize: number): Vector2;
122122

‎definitions/latite.d.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,12 @@ interface ClientEvents {
237237

238238
interface Latite {
239239
/**
240-
* Listen to an event.
240+
* Listens to a client-side event.
241+
* @param eventName The event to listen to
242+
* @param listener The event callback
243+
* @param priority Positive or negative integer. The priority in which the event listener should have over other events globally. The default is 0. Greater = called first, less = called later.
241244
*/
242-
on<K extends keyof ClientEvents>(eventName: K, listener: (event: ClientEvents[K]) => void): void
245+
on<K extends keyof ClientEvents>(eventName: K, listener: (event: ClientEvents[K]) => void, priority?: number): void
243246

244247
/**
245248
* Shows a Latite toast on the top of the screen.

‎definitions/world/entity.d.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,20 @@ declare class Entity {
110110
* @param value The variable's new value.
111111
*/
112112
setMolangVariable(name: string, value: number): number | null;
113+
114+
/**
115+
* Gets a status flag's state in the current entity.
116+
* @param type The entity status flag to get
117+
*/
118+
getFlag(flag: number): boolean;
119+
120+
121+
/**
122+
* Sets a status flag's state in the current entity.
123+
* @param type The entity status flag to get
124+
* @param value The new status flag value.
125+
*/
126+
setFlag(flag: number, value: boolean): void;
113127
}
114128

115129
declare class Player extends Entity {

‎docs-markdown/module.api_TextColor/interfaces/interface.ITextColor.md‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,221 +8,221 @@
88

99
**`Interface`**
1010

11-
**Source:** [api/TextColor.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L1)
11+
**Source:** [api/TextColor.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L1)
1212

1313
## Properties
1414

1515
### AQUA
1616

1717
> **AQUA**: `string`
1818
19-
**Source:** [api/TextColor.d.ts:24](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L24)
19+
**Source:** [api/TextColor.d.ts:24](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L24)
2020

2121
### BLACK
2222

2323
> **BLACK**: `string`
2424
25-
**Source:** [api/TextColor.d.ts:13](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L13)
25+
**Source:** [api/TextColor.d.ts:13](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L13)
2626

2727
### BLUE
2828

2929
> **BLUE**: `string`
3030
31-
**Source:** [api/TextColor.d.ts:22](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L22)
31+
**Source:** [api/TextColor.d.ts:22](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L22)
3232

3333
### BOLD
3434

3535
> **BOLD**: `string`
3636
37-
**Source:** [api/TextColor.d.ts:7](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L7)
37+
**Source:** [api/TextColor.d.ts:7](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L7)
3838

3939
### DARK_AQUA
4040

4141
> **DARK_AQUA**: `string`
4242
43-
**Source:** [api/TextColor.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L16)
43+
**Source:** [api/TextColor.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L16)
4444

4545
### DARK_BLUE
4646

4747
> **DARK_BLUE**: `string`
4848
49-
**Source:** [api/TextColor.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L14)
49+
**Source:** [api/TextColor.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L14)
5050

5151
### DARK_GRAY
5252

5353
> **DARK_GRAY**: `string`
5454
55-
**Source:** [api/TextColor.d.ts:21](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L21)
55+
**Source:** [api/TextColor.d.ts:21](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L21)
5656

5757
### DARK_GREEN
5858

5959
> **DARK_GREEN**: `string`
6060
61-
**Source:** [api/TextColor.d.ts:15](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L15)
61+
**Source:** [api/TextColor.d.ts:15](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L15)
6262

6363
### DARK_PURPLE
6464

6565
> **DARK_PURPLE**: `string`
6666
67-
**Source:** [api/TextColor.d.ts:18](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L18)
67+
**Source:** [api/TextColor.d.ts:18](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L18)
6868

6969
### DARK_RED
7070

7171
> **DARK_RED**: `string`
7272
73-
**Source:** [api/TextColor.d.ts:17](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L17)
73+
**Source:** [api/TextColor.d.ts:17](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L17)
7474

7575
### FORMAT_CHAR
7676

7777
> **FORMAT_CHAR**: `string`
7878
79-
**Source:** [api/TextColor.d.ts:2](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L2)
79+
**Source:** [api/TextColor.d.ts:2](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L2)
8080

8181
### GOLD
8282

8383
> **GOLD**: `string`
8484
85-
**Source:** [api/TextColor.d.ts:19](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L19)
85+
**Source:** [api/TextColor.d.ts:19](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L19)
8686

8787
### GRAY
8888

8989
> **GRAY**: `string`
9090
91-
**Source:** [api/TextColor.d.ts:20](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L20)
91+
**Source:** [api/TextColor.d.ts:20](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L20)
9292

9393
### GREEN
9494

9595
> **GREEN**: `string`
9696
97-
**Source:** [api/TextColor.d.ts:23](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L23)
97+
**Source:** [api/TextColor.d.ts:23](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L23)
9898

9999
### ITALIC
100100

101101
> **ITALIC**: `string`
102102
103-
**Source:** [api/TextColor.d.ts:8](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L8)
103+
**Source:** [api/TextColor.d.ts:8](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L8)
104104

105105
### LIGHT_PURPLE
106106

107107
> **LIGHT_PURPLE**: `string`
108108
109-
**Source:** [api/TextColor.d.ts:26](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L26)
109+
**Source:** [api/TextColor.d.ts:26](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L26)
110110

111111
### MATERIAL_AMETHYST
112112

113113
> **MATERIAL_AMETHYST**: `string`
114114
115115
1.20 ONLY
116116

117-
**Source:** [api/TextColor.d.ts:73](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L73)
117+
**Source:** [api/TextColor.d.ts:73](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L73)
118118

119119
### MATERIAL_COPPER
120120

121121
> **MATERIAL_COPPER**: `string`
122122
123123
1.20 ONLY
124124

125-
**Source:** [api/TextColor.d.ts:53](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L53)
125+
**Source:** [api/TextColor.d.ts:53](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L53)
126126

127127
### MATERIAL_DIAMOND
128128

129129
> **MATERIAL_DIAMOND**: `string`
130130
131131
1.20 ONLY
132132

133-
**Source:** [api/TextColor.d.ts:65](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L65)
133+
**Source:** [api/TextColor.d.ts:65](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L65)
134134

135135
### MATERIAL_EMERALD
136136

137137
> **MATERIAL_EMERALD**: `string`
138138
139139
1.20 ONLY
140140

141-
**Source:** [api/TextColor.d.ts:61](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L61)
141+
**Source:** [api/TextColor.d.ts:61](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L61)
142142

143143
### MATERIAL_GOLD
144144

145145
> **MATERIAL_GOLD**: `string`
146146
147147
1.20 ONLY
148148

149-
**Source:** [api/TextColor.d.ts:57](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L57)
149+
**Source:** [api/TextColor.d.ts:57](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L57)
150150

151151
### MATERIAL_IRON
152152

153153
> **MATERIAL_IRON**: `string`
154154
155155
1.20 ONLY
156156

157-
**Source:** [api/TextColor.d.ts:41](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L41)
157+
**Source:** [api/TextColor.d.ts:41](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L41)
158158

159159
### MATERIAL_LAPIS
160160

161161
> **MATERIAL_LAPIS**: `string`
162162
163163
1.20 ONLY
164164

165-
**Source:** [api/TextColor.d.ts:69](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L69)
165+
**Source:** [api/TextColor.d.ts:69](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L69)
166166

167167
### MATERIAL_NETHERITE
168168

169169
> **MATERIAL_NETHERITE**: `string`
170170
171171
1.20 ONLY
172172

173-
**Source:** [api/TextColor.d.ts:45](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L45)
173+
**Source:** [api/TextColor.d.ts:45](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L45)
174174

175175
### MATERIAL_QUARTZ
176176

177177
> **MATERIAL_QUARTZ**: `string`
178178
179179
1.20 ONLY
180180

181-
**Source:** [api/TextColor.d.ts:37](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L37)
181+
**Source:** [api/TextColor.d.ts:37](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L37)
182182

183183
### MATERIAL_REDSTONE
184184

185185
> **MATERIAL_REDSTONE**: `string`
186186
187187
1.20 ONLY
188188

189-
**Source:** [api/TextColor.d.ts:49](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L49)
189+
**Source:** [api/TextColor.d.ts:49](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L49)
190190

191191
### MINECOIN_GOLD
192192

193193
> **MINECOIN_GOLD**: `string`
194194
195-
**Source:** [api/TextColor.d.ts:32](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L32)
195+
**Source:** [api/TextColor.d.ts:32](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L32)
196196

197197
### OBFUSCATE
198198

199199
> **OBFUSCATE**: `string`
200200
201-
**Source:** [api/TextColor.d.ts:6](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L6)
201+
**Source:** [api/TextColor.d.ts:6](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L6)
202202

203203
### RED
204204

205205
> **RED**: `string`
206206
207-
**Source:** [api/TextColor.d.ts:25](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L25)
207+
**Source:** [api/TextColor.d.ts:25](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L25)
208208

209209
### RESET
210210

211211
> **RESET**: `string`
212212
213-
**Source:** [api/TextColor.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L9)
213+
**Source:** [api/TextColor.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L9)
214214

215215
### WHITE
216216

217217
> **WHITE**: `string`
218218
219-
**Source:** [api/TextColor.d.ts:28](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L28)
219+
**Source:** [api/TextColor.d.ts:28](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L28)
220220

221221
### YELLOW
222222

223223
> **YELLOW**: `string`
224224
225-
**Source:** [api/TextColor.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L27)
225+
**Source:** [api/TextColor.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L27)
226226

227227
## Methods
228228

@@ -232,7 +232,7 @@
232232
233233
Formats '&' into colorcoded string.
234234

235-
**Source:** [api/TextColor.d.ts:79](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L79)
235+
**Source:** [api/TextColor.d.ts:79](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L79)
236236

237237
#### Parameters
238238

‎docs-markdown/module.api_TextColor/variables/variable.TextColor.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010

1111
> `const` **TextColor**: [`ITextColor`](../interfaces/interface.ITextColor.md)
1212
13-
**Source:** [api/TextColor.d.ts:82](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/api/TextColor.d.ts#L82)
13+
**Source:** [api/TextColor.d.ts:82](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/api/TextColor.d.ts#L82)

‎docs-markdown/module.feature_command/classes/class.Command.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
**`Class`**
1010

11-
**Source:** [feature/command.d.ts:13](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/feature/command.d.ts#L13)
11+
**Source:** [feature/command.d.ts:13](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/feature/command.d.ts#L13)
1212

1313
## Constructors
1414

@@ -20,7 +20,7 @@
2020
> usage: `string`,
2121
> aliases: `string`[]): [`Command`](class.Command.md)
2222
23-
**Source:** [feature/command.d.ts:25](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/feature/command.d.ts#L25)
23+
**Source:** [feature/command.d.ts:25](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/feature/command.d.ts#L25)
2424

2525
#### Parameters
2626

@@ -41,31 +41,31 @@
4141

4242
> `readonly` **aliases**: `string`[]
4343
44-
**Source:** [feature/command.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/feature/command.d.ts#L16)
44+
**Source:** [feature/command.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/feature/command.d.ts#L16)
4545

4646
### description
4747

4848
> `readonly` **description**: `string`
4949
50-
**Source:** [feature/command.d.ts:15](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/feature/command.d.ts#L15)
50+
**Source:** [feature/command.d.ts:15](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/feature/command.d.ts#L15)
5151

5252
### name
5353

5454
> `readonly` **name**: `string`
5555
56-
**Source:** [feature/command.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/feature/command.d.ts#L14)
56+
**Source:** [feature/command.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/feature/command.d.ts#L14)
5757

5858
### on
5959

6060
> **on**: `Function`
6161
62-
**Source:** [feature/command.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/feature/command.d.ts#L27)
62+
**Source:** [feature/command.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/feature/command.d.ts#L27)
6363

6464
#### Type declaration (on)
6565

6666
> > \<K\>(eventName: `K`, handler: [`CommandEvents`](../interfaces/interface.CommandEvents.md)[`K`]): `void`
6767
>
68-
> **Source:** [feature/command.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/a4de419/definitions/feature/command.d.ts#L27)
68+
> **Source:** [feature/command.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/303196e/definitions/feature/command.d.ts#L27)
6969
>
7070
> ##### Type parameters
7171
>

0 commit comments

Comments
 (0)