Skip to content
On this page

AthenaClient.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

NameType
spriteSpriteInfo

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

NameTypeDescription
uidstringA 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

NameTypeDescription
uidstringA unique string
spritePartial<SpriteInfo>

Returns

void

Defined in

client/rmlui/sprites/index.ts:263

Created by Stuyk | Est. 2020