Overlay Module¶
Picture
The Overlay Module allows scripts render stuff on player's GUI.
Objects¶
OverlayObject¶
getId¶
getId() -> number
returns the object's integer ID.
setEnabled¶
setEnabled(enable: boolean) -> nil
set whether or not to render the object.
isEnabled¶
isEnabled() -> boolean
returns whether or not the object is rendering.
RenderableObject¶
Based on OverlayObject
| Field | Type | Default Value | Description |
|---|---|---|---|
opacity |
number |
1 |
A decimal number that determines the transparency of the object, in range of |
color |
number |
0xffffff |
An integer that determines the color of the object, in format of 0xRRGGBB |
x |
number |
0 |
Integer of object's X position, in range of |
y |
number |
0 |
Integer of object's Y position, in range of |
z |
number |
0 |
Integer of object's Z position, in range of |
maxX |
number |
0 |
Integer of object's maximum X position, in range of |
maxY |
number |
0 |
Integer of object's maximum Y position, in range of |
maxZ |
number |
0 |
Integer of object's maximum Z position, in range of |
RectangleObject¶
Based on RenderableObject
CircleObject¶
Based on RenderableObject
| Field | Type | Default Value | Description |
|---|---|---|---|
radius |
number |
0 |
Integer of the circle's radius, in range of |
TextObject¶
Based on RenderableObject
| Field | Type | Default Value | Description |
|---|---|---|---|
content |
string |
"" |
The text to render |
fontSize |
number |
1 |
A decimal number represents the text's font size, in range of |
shadow |
boolean |
false |
Whether or not render a shadow for the text |
ItemObject¶
Based on RenderableObject
| Field | Type | Default Value | Description |
|---|---|---|---|
id |
string |
"minecraft:air" |
The registry ID of the item to render |
ThreeDimensionalObject¶
Based on RenderableObject
| Field | Type | Default Value | Description |
|---|---|---|---|
disableDepthTest |
boolean |
false |
If true, the block will not hidden behind other objects, false otherwise |
disableCulling |
boolean |
false |
If true, the block will not hidden faces cannot be seen, false otherwise |
xRot |
number |
0 |
A decimal number determine the degrees the block rotates on the X-axis, in range of |
yRot |
number |
0 |
A decimal number determine the degrees the block rotates on the Y-axis, in range of |
zRot |
number |
0 |
A decimal number determine the degrees the block rotates on the Z-axis, in range of |
BlockObject¶
Based on ThreeDimensionalObject
| Field | Type | Default Value | Description |
|---|---|---|---|
block |
string |
"minecraft:air" |
The registry ID of the block to render |
BoxObject¶
Based on ThreeDimensionalObject
SphereObject¶
Based on ThreeDimensionalObject
| Field | Type | Default Value | Description |
|---|---|---|---|
sectors |
number |
16 |
An integer in range of |
stacks |
number |
16 |
An integer in range of |
radius |
number |
1 |
A decimal number of the sphere's radius, in range of (0, 128] |
TorusObject¶
Based on ThreeDimensionalObject
| Field | Type | Default Value | Description |
|---|---|---|---|
sides |
number |
32 |
An integer in range of |
rings |
number |
16 |
An integer in range of |
minorRadius |
number |
0.1 |
A decimal number of inner radius of the ring, in range of (0, 128] |
majorRadius |
number |
0.5 |
A decimal number of outer radius of the ring, in range of (0, 128] |
Functions¶
createRectangle¶
createRectangle(object: table) -> table, "SUCCESS"
object is a RectangleObject
returns a copy of the object with getters & setters to change its properties.
createCircle¶
createCircle(object: table) -> table, "SUCCESS"
object is a CircleObject
returns a copy of the object with getters & setters to change its properties.
createText¶
createText(object: table) -> table, "SUCCESS"
object is a TextObject
returns a copy of the object with getters & setters to change its properties.
createItem¶
createItem(object: table) -> table, "SUCCESS"
object is a ItemObject
returns a copy of the object with getters & setters to change its properties.
createBlock¶
createBlock(object: table) -> table, "SUCCESS"
object is a BlockObject
returns a copy of the object with getters & setters to change its properties.
createBox¶
createBox(object: table) -> table, "SUCCESS"
object is a BoxObject
returns a copy of the object with getters & setters to change its properties.
createSphere¶
createSphere(object: table) -> table, "SUCCESS"
object is a SphereObject
returns a copy of the object with getters & setters to change its properties.
createTorus¶
createTorus(object: table) -> table, "SUCCESS"
object is a TorusObject
returns a copy of the object with getters & setters to change its properties.
getObject¶
getObject(id: number) -> table | nil
returns a RenderableObject by the object's ID, or nil if the ID not exists.
clear¶
clear() -> number
remove all objects, returns the number of removed object.
getObjectsSize¶
getObjectsSize() -> number
returns the number of all objects.
getSize¶
getSize() -> number, number
returns the client's width and height
getCoords¶
getCoords() -> number, number, number
returns the player's eye position
update¶
update() -> number
update objects, returns the number of updated object.
autoUpdate¶
autoUpdate(value: boolean | nil) -> boolean
set auto update and returns if the objects will be auto updated.
If the value is a boolean, the auto update flag will set to that value.
If the value is not presented (aka nil), the auto update flag will stay unchanged
Changelog/Trivia¶
0.8
Added Overlay Module