V5 DocsAthenaClient.rmlui.sprites ​
Interfaces ​
Functions ​
create ​
Usage
AthenaClient.rmlui.sprites.create(sprite): void
Create a sprite. Create a JavaScript object to start building the sprite.
Parameters ​
| Name | Type |
|---|---|
sprite | SpriteInfo |
Returns ​
void
Defined in ​
client/rmlui/sprites/index.ts:222
remove ​
Usage
AthenaClient.rmlui.sprites.remove(uid): void
Remove a sprite by uid and stop it from updating entirely.
Parameters ​
| Name | Type | Description |
|---|---|---|
uid | string | A unique string |
Returns ​
void
Defined in ​
client/rmlui/sprites/index.ts:246
update ​
Usage
AthenaClient.rmlui.sprites.update(uid, sprite): void
Updates the sprite data. Use this to update position of the sprite dynamically. Requires the uid specified to update it.
Parameters ​
| Name | Type | Description |
|---|---|---|
uid | string | A unique string |
sprite | Partial<SpriteInfo> |
Returns ​
void