Skip to content

Commit 796c413

Browse files
PlextoraPlextora
committed
Update docs
1 parent e10e2da commit 796c413

File tree

192 files changed

+2631
-1375
lines changed

Some content is hidden

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

192 files changed

+2631
-1375
lines changed

‎definitions/feature/hudmodule.d.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,7 @@ declare class HudModule extends Module {
1212

1313
declare class TextModule extends HudModule {
1414
constructor(name: string, displayName: string, description: string, key: KeyCode);
15+
16+
// Get the last post-processed text that was displayed.
17+
getLastText(): string;
1518
}

‎definitions/gfx/graphics.d.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,15 @@ declare interface Graphics {
152152
* @param color The overlay color of the texture (defaults to white)
153153
*/
154154
drawTexture(texture: Texture, pos: Vector2, sizeX: number, sizeY: number, color?: Color): void;
155+
156+
/**
157+
* Draw an item instance.
158+
* @param item The item to draw
159+
* @param pos The position in pixels to draw the texture
160+
* @param sizeModifier The relative size modifier (defualt: 1.0, aka 16 pixels)
161+
* @param opacity The opacity of the item
162+
*/
163+
drawItem(item: ItemStack, pos: Vector2, sizeModifier: number, opacity: number): void;
155164
}
156165

157166
declare const graphics: Graphics;

‎definitions/latite.d.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ interface ClickEvent extends CancellableEvent {
5252
readonly isDown: boolean;
5353
readonly mouseX: number;
5454
readonly mouseY: number;
55+
readonly wheelDelta: number;
5556
}
5657

5758
interface KeyEvent extends CancellableEvent {
@@ -233,6 +234,16 @@ interface ClientEvents {
233234
* Calls whenever the player goes into a different dimension.
234235
*/
235236
"change-dimension": LatiteEvent;
237+
238+
/**
239+
* Called before movement input is processed. This is cancellable.
240+
*/
241+
"pre-move": CancellableEvent;
242+
243+
/**
244+
* Called after movement input is processed.
245+
*/
246+
"post-move": LatiteEvent;
236247
}
237248

238249
interface Latite {

‎definitions/lib/filesystem.d.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
declare namespace include {
22
export interface Filesystem {
3+
/**
4+
*
5+
* @param path The path of the file
6+
*/
7+
delete(path: string): void;
8+
39
/**
410
* Reads a file asynchronously.
511
* @param path The path to read from.
@@ -45,5 +51,11 @@ declare namespace include {
4551
* @param data The data to append, for example, `util.bufferToString("hello")`
4652
*/
4753
append(path: string, data: Buffer): void;
54+
55+
/**
56+
* Gets a list of the contents of a directory.
57+
* @param path The path to the directory.
58+
*/
59+
readDirectory(path: string): string[];
4860
}
4961
}

‎definitions/world/entity.d.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,20 @@ declare class Entity {
124124
* @param value The new status flag value.
125125
*/
126126
setFlag(flag: number, value: boolean): void;
127+
128+
/**
129+
* Gets the entity's movement velocity.
130+
*/
131+
getVelocity(): Vector3;
132+
133+
134+
/**
135+
* Sets the entity's movement velocity.
136+
*
137+
* This function is restricted - it only works if you have operator.
138+
* @param vector The new velocity
139+
*/
140+
setVelocity(vector: Vector3): void;
127141
}
128142

129143
declare class Player extends Entity {
@@ -160,6 +174,16 @@ declare const enum LookingAt {
160174
Air
161175
}
162176

177+
interface MovementState {
178+
forward: boolean;
179+
backward: boolean;
180+
left: boolean;
181+
right: boolean;
182+
jump: boolean;
183+
sneak: boolean;
184+
readonly sprintHeld: boolean;
185+
}
186+
163187
declare class LocalPlayer extends Player {
164188
/**
165189
* Get the progress of breaking a block (ranging from 0 to 1)
@@ -180,4 +204,16 @@ declare class LocalPlayer extends Player {
180204
* Get the block selected by looking at it. Will return null if no block is selected.
181205
*/
182206
getSelectedBlock(): Vector3 | null;
207+
208+
209+
/**
210+
* Gets the movement state of the player (i.e. the movement keys held.)
211+
*/
212+
getMovementState(): MovementState;
213+
214+
/**
215+
* Sets the movement state of the player
216+
* @param state The state to update to
217+
*/
218+
setMovementState(state: MovementState): void;
183219
}

‎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/1720dc7/definitions/api/TextColor.d.ts#L1)
11+
**Source:** [api/TextColor.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L24)
19+
**Source:** [api/TextColor.d.ts:24](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L13)
25+
**Source:** [api/TextColor.d.ts:13](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L22)
31+
**Source:** [api/TextColor.d.ts:22](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L7)
37+
**Source:** [api/TextColor.d.ts:7](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L16)
43+
**Source:** [api/TextColor.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L14)
49+
**Source:** [api/TextColor.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L21)
55+
**Source:** [api/TextColor.d.ts:21](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L15)
61+
**Source:** [api/TextColor.d.ts:15](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L18)
67+
**Source:** [api/TextColor.d.ts:18](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L17)
73+
**Source:** [api/TextColor.d.ts:17](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L2)
79+
**Source:** [api/TextColor.d.ts:2](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L19)
85+
**Source:** [api/TextColor.d.ts:19](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L20)
91+
**Source:** [api/TextColor.d.ts:20](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L23)
97+
**Source:** [api/TextColor.d.ts:23](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L8)
103+
**Source:** [api/TextColor.d.ts:8](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L26)
109+
**Source:** [api/TextColor.d.ts:26](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L73)
117+
**Source:** [api/TextColor.d.ts:73](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L53)
125+
**Source:** [api/TextColor.d.ts:53](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L65)
133+
**Source:** [api/TextColor.d.ts:65](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L61)
141+
**Source:** [api/TextColor.d.ts:61](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L57)
149+
**Source:** [api/TextColor.d.ts:57](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L41)
157+
**Source:** [api/TextColor.d.ts:41](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L69)
165+
**Source:** [api/TextColor.d.ts:69](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L45)
173+
**Source:** [api/TextColor.d.ts:45](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L37)
181+
**Source:** [api/TextColor.d.ts:37](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L49)
189+
**Source:** [api/TextColor.d.ts:49](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L32)
195+
**Source:** [api/TextColor.d.ts:32](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L6)
201+
**Source:** [api/TextColor.d.ts:6](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L25)
207+
**Source:** [api/TextColor.d.ts:25](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L9)
213+
**Source:** [api/TextColor.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L28)
219+
**Source:** [api/TextColor.d.ts:28](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L27)
225+
**Source:** [api/TextColor.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/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/1720dc7/definitions/api/TextColor.d.ts#L79)
235+
**Source:** [api/TextColor.d.ts:79](https://github.com/LatiteScripting/latitescripting.github.io/blob/e10e2da/definitions/api/TextColor.d.ts#L79)
236236

237237
#### Parameters
238238

0 commit comments

Comments
 (0)