V5 DocsAthenaClient.screen.text ​
Functions ​
addTemporaryText ​
Usage
AthenaClient.screen.text.addTemporaryText(identifier, msg, x, y, scale, r, g, b, a, ms): void
Adds text temporarily on the screen.
Parameters ​
| Name | Type |
|---|---|
identifier | any |
msg | any |
x | any |
y | any |
scale | any |
r | any |
g | any |
b | any |
a | any |
ms | any |
Returns ​
void
Defined in ​
drawRectangle ​
Usage
AthenaClient.screen.text.drawRectangle(pos, size, color): void
Draw a box at a 3D coordinate
Parameters ​
| Name | Type | Description |
|---|---|---|
pos | IVector3 | A position in the world. |
size | IVector2 | |
color | RGBA |
Returns ​
void
Defined in ​
drawRectangle2D ​
Usage
AthenaClient.screen.text.drawRectangle2D(pos, size, color): void
Draw a box on-screen
Parameters ​
| Name | Type |
|---|---|
pos | IVector2 |
size | IVector2 |
color | RGBA |
Returns ​
void
Defined in ​
drawText2D ​
Usage
AthenaClient.screen.text.drawText2D(text, pos, scale, color, alignment?, padding?): void
Draw text on your screen in a 2D position with an every tick.
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
text | string | undefined | |
pos | IVector2 | undefined | |
scale | number | undefined | |
color | RGBA | undefined | |
alignment | number | 0 | 0 Center, 1 Left, 2 Right |
padding | number | 0 | - |
Returns ​
void
Defined in ​
drawText3D ​
Usage
AthenaClient.screen.text.drawText3D(text, pos, scale, color): void
Draw stable text in a 3D position with an every tick.
Parameters ​
| Name | Type |
|---|---|
text | string |
pos | IVector3 |
scale | number |
color | RGBA |
Returns ​
void