Skip to content

Commit 81956fd

Browse files
committed
Update documentation
1 parent 5c02322 commit 81956fd

File tree

83 files changed

+4122
-664
lines changed

Some content is hidden

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

83 files changed

+4122
-664
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
<h1>Documentation for Latite Client Scripting</h1>
33
<p><a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/docs-markdown/exports.md">Documentation in Markdown</a></p>
44

5-
<a href="LICENSE.md">License</a>
5+
<a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/LICENSE.md">License</a>
66
</div>
77

docs-markdown/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
<h1>Documentation for Latite Client Scripting</h1>
77
<p><a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/docs-markdown/exports.md">Documentation in Markdown</a></p>
88

9-
<a href="LICENSE.md">License</a>
9+
<a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/LICENSE.md">License</a>
1010

1111
</div>

docs-markdown/exports.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- [entity](module.entity/index.md)
1212
- [game](module.game/index.md)
1313
- [graphics](module.graphics/index.md)
14+
- [hudmodule](module.hudmodule/index.md)
1415
- [key](module.key/index.md)
1516
- [latite](module.latite/index.md)
1617
- [mmgr](module.mmgr/index.md)

docs-markdown/module.entity/classes/class.Entity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
A class representing an in-game entity.
1212

13-
**Source:** [entity.d.ts:4](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/entity.d.ts#L4)
13+
**Source:** [entity.d.ts:4](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/entity.d.ts#L4)
1414

1515
## Hierarchy
1616

@@ -35,7 +35,7 @@ A class representing an in-game entity.
3535
Check if the entity is still valid. In some cases, Latite may invalidate an entity outside of an
3636
event listener. This is to prevent the scripting engine from being used as a cheat.
3737

38-
**Source:** [entity.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/entity.d.ts#L9)
38+
**Source:** [entity.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/entity.d.ts#L9)
3939

4040
#### Returns
4141

docs-markdown/module.entity/classes/class.Player.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
A class representing an in-game entity.
1212

13-
**Source:** [entity.d.ts:12](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/entity.d.ts#L12)
13+
**Source:** [entity.d.ts:12](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/entity.d.ts#L12)
1414

1515
## Hierarchy
1616

@@ -38,7 +38,7 @@ A class representing an in-game entity.
3838
3939
Get the player's name (same one as the player list in the pause menu.)
4040

41-
**Source:** [entity.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/entity.d.ts#L16)
41+
**Source:** [entity.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/entity.d.ts#L16)
4242

4343
#### Returns
4444

@@ -51,7 +51,7 @@ Get the player's name (same one as the player list in the pause menu.)
5151
Check if the entity is still valid. In some cases, Latite may invalidate an entity outside of an
5252
event listener. This is to prevent the scripting engine from being used as a cheat.
5353

54-
**Source:** [entity.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/entity.d.ts#L9)
54+
**Source:** [entity.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/entity.d.ts#L9)
5555

5656
#### Returns
5757

docs-markdown/module.game/interfaces/interface.Game.md

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

99
**`Interface`**
1010

11-
**Source:** [game.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L1)
11+
**Source:** [game.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L1)
1212

1313
## Methods
1414

@@ -18,7 +18,7 @@
1818
1919
Execute an in-game command.
2020

21-
**Source:** [game.d.ts:12](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L12)
21+
**Source:** [game.d.ts:12](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L12)
2222

2323
#### Parameters
2424

@@ -38,7 +38,7 @@ Gets the featured server name you are connected to. This will return null if you
3838

3939
Featured server examples: "The Hive" "CubeCraft" "InPvP" "Mineplex"
4040

41-
**Source:** [game.d.ts:29](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L29)
41+
**Source:** [game.d.ts:29](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L29)
4242

4343
#### Returns
4444

@@ -50,7 +50,7 @@ Featured server examples: "The Hive" "CubeCraft" "InPvP" "Mineplex"
5050
5151
Gets the server you are connected to. This will return null if you are not in a server.
5252

53-
**Source:** [game.d.ts:22](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L22)
53+
**Source:** [game.d.ts:22](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L22)
5454

5555
#### Returns
5656

@@ -62,7 +62,7 @@ Gets the server you are connected to. This will return null if you are not in a
6262
6363
Get your player. This will return null if you are not in a game.
6464

65-
**Source:** [game.d.ts:17](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L17)
65+
**Source:** [game.d.ts:17](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L17)
6666

6767
#### Returns
6868

@@ -74,7 +74,7 @@ Get your player. This will return null if you are not in a game.
7474
7575
Get the current world that you're in.
7676

77-
**Source:** [game.d.ts:34](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L34)
77+
**Source:** [game.d.ts:34](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L34)
7878

7979
#### Returns
8080

@@ -86,7 +86,7 @@ Get the current world that you're in.
8686
8787
Sends a chat message.
8888

89-
**Source:** [game.d.ts:6](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L6)
89+
**Source:** [game.d.ts:6](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L6)
9090

9191
#### Parameters
9292

docs-markdown/module.game/variables/variable.game-1.md

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

1111
> `const` **game**: [`Game`](../interfaces/interface.Game.md)
1212
13-
**Source:** [game.d.ts:37](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/game.d.ts#L37)
13+
**Source:** [game.d.ts:37](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/game.d.ts#L37)

docs-markdown/module.graphics/classes/class.Rect.md

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

99
**`Class`**
1010

11-
**Source:** [graphics.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L1)
11+
**Source:** [graphics.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L1)
1212

1313
## Constructors
1414

@@ -22,7 +22,7 @@
2222
2323
A class representing a rectangle on the screen.
2424

25-
**Source:** [graphics.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L9)
25+
**Source:** [graphics.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L9)
2626

2727
#### Parameters
2828

@@ -39,7 +39,7 @@ A class representing a rectangle on the screen.
3939

4040
> **new Rect**(): [`Rect`](class.Rect.md)
4141
42-
**Source:** [graphics.d.ts:11](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L11)
42+
**Source:** [graphics.d.ts:11](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L11)
4343

4444
#### Returns
4545

docs-markdown/module.graphics/classes/class.Vector2.md

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

99
**`Class`**
1010

11-
**Source:** [graphics.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L14)
11+
**Source:** [graphics.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L14)
1212

1313
## Constructors
1414

@@ -18,7 +18,7 @@
1818
1919
A point on the screen.
2020

21-
**Source:** [graphics.d.ts:20](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L20)
21+
**Source:** [graphics.d.ts:20](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L20)
2222

2323
#### Parameters
2424

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[**Latite Scripting Documentation**](../../README.md) ([**Exports**](../../exports.md))
2+
3+
---
4+
5+
[Exports](../../exports.md) > [graphics](../index.md) > Font
6+
7+
# Font
8+
9+
**`Enumeration`**
10+
11+
**Source:** [graphics.d.ts:31](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L31)
12+
13+
## Enumeration Members
14+
15+
### Minecraft
16+
17+
> **Minecraft**: 1
18+
19+
By default, this is Mojangles
20+
21+
**Source:** [graphics.d.ts:39](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L39)
22+
23+
### MinecraftTen
24+
25+
> **MinecraftTen**: 2
26+
27+
**Source:** [graphics.d.ts:40](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L40)
28+
29+
### Smooth
30+
31+
> **Smooth**: 0
32+
33+
By default, this is Noto Sans
34+
35+
**Source:** [graphics.d.ts:35](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L35)
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[**Latite Scripting Documentation**](../../README.md) ([**Exports**](../../exports.md))
2+
3+
---
4+
5+
[Exports](../../exports.md) > [graphics](../index.md) > TextAlignment
6+
7+
# TextAlignment
8+
9+
**`Enumeration`**
10+
11+
**Source:** [graphics.d.ts:25](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L25)
12+
13+
## Enumeration Members
14+
15+
### Center
16+
17+
> **Center**: 2
18+
19+
**Source:** [graphics.d.ts:28](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L28)
20+
21+
### Left
22+
23+
> **Left**: 0
24+
25+
**Source:** [graphics.d.ts:26](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L26)
26+
27+
### Right
28+
29+
> **Right**: 1
30+
31+
**Source:** [graphics.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L27)

docs-markdown/module.graphics/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@
88

99
## Index
1010

11+
### Enumerations
12+
13+
- [Font](enumerations/enumeration.Font.md)
14+
- [TextAlignment](enumerations/enumeration.TextAlignment.md)
15+
1116
### Classes
1217

1318
- [Rect](classes/class.Rect.md)
@@ -17,6 +22,10 @@
1722

1823
- [Graphics2D](interfaces/interface.Graphics2D.md)
1924

25+
### Type Aliases
26+
27+
- [Color](type-aliases/type-alias.Color.md)
28+
2029
### Variables
2130

2231
- [graphics](variables/variable.graphics.md)

docs-markdown/module.graphics/interfaces/interface.Graphics2D.md

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

99
**`Interface`**
1010

11-
**Source:** [graphics.d.ts:23](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L23)
11+
**Source:** [graphics.d.ts:43](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L43)
1212

1313
## Methods
1414

1515
### drawRect()
1616

1717
> **drawRect**(
1818
> rect: [`Rect`](../classes/class.Rect.md),
19-
> color: [`number`, `number`, `number`, `number`],
19+
> color: [`Color`](../type-aliases/type-alias.Color.md),
2020
> thickness: `number`): `void`
2121
22-
**Source:** [graphics.d.ts:24](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L24)
22+
**Source:** [graphics.d.ts:44](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L44)
2323

2424
#### Parameters
2525

26-
| Parameter | Type |
27-
| :-------- | :--------------------------------------- |
28-
| rect | [`Rect`](../classes/class.Rect.md) |
29-
| color | [`number`, `number`, `number`, `number`] |
30-
| thickness | `number` |
26+
| Parameter | Type |
27+
| :-------- | :--------------------------------------------- |
28+
| rect | [`Rect`](../classes/class.Rect.md) |
29+
| color | [`Color`](../type-aliases/type-alias.Color.md) |
30+
| thickness | `number` |
31+
32+
#### Returns
33+
34+
`void`
35+
36+
### drawText()
37+
38+
> **drawText**(
39+
> rect: [`Rect`](../classes/class.Rect.md),
40+
> color: [`Color`](../type-aliases/type-alias.Color.md),
41+
> text: `string`,
42+
> size: `number`,
43+
> font: [`Font`](../enumerations/enumeration.Font.md),
44+
> alignment: [`TextAlignment`](../enumerations/enumeration.TextAlignment.md)): `void`
45+
46+
**Source:** [graphics.d.ts:46](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L46)
47+
48+
#### Parameters
49+
50+
| Parameter | Type |
51+
| :-------- | :-------------------------------------------------------------- |
52+
| rect | [`Rect`](../classes/class.Rect.md) |
53+
| color | [`Color`](../type-aliases/type-alias.Color.md) |
54+
| text | `string` |
55+
| size | `number` |
56+
| font | [`Font`](../enumerations/enumeration.Font.md) |
57+
| alignment | [`TextAlignment`](../enumerations/enumeration.TextAlignment.md) |
58+
59+
#### Returns
60+
61+
`void`
62+
63+
### fillRect()
64+
65+
> **fillRect**(rect: [`Rect`](../classes/class.Rect.md), color: [`Color`](../type-aliases/type-alias.Color.md)): `void`
66+
67+
**Source:** [graphics.d.ts:45](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L45)
68+
69+
#### Parameters
70+
71+
| Parameter | Type |
72+
| :-------- | :--------------------------------------------- |
73+
| rect | [`Rect`](../classes/class.Rect.md) |
74+
| color | [`Color`](../type-aliases/type-alias.Color.md) |
3175

3276
#### Returns
3377

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[**Latite Scripting Documentation**](../../README.md) ([**Exports**](../../exports.md))
2+
3+
---
4+
5+
[Exports](../../exports.md) > [graphics](../index.md) > Color
6+
7+
# Color
8+
9+
**`Type alias`**
10+
11+
> **Color**: [`number`, `number`, `number`, `number`]
12+
13+
**Source:** [graphics.d.ts:23](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L23)

docs-markdown/module.graphics/variables/variable.graphics.md

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

1111
> `const` **graphics**: [`Graphics2D`](../interfaces/interface.Graphics2D.md)
1212
13-
**Source:** [graphics.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/5231c68/definitions/graphics.d.ts#L27)
13+
**Source:** [graphics.d.ts:49](https://github.com/LatiteScripting/latitescripting.github.io/blob/5c02322/definitions/graphics.d.ts#L49)

0 commit comments

Comments
 (0)