Skip to content
On this page

AthenaClient.rmlui.sprites.SpriteInfo ​

client/rmlui/sprites.SpriteInfo

Properties ​

callOnceOnTouch ​

• Optional callOnceOnTouch: (uid: string) => void

Type declaration ​

Usage

AthenaClient.rmlui.sprites.SpriteInfo.(uid): void

Call this callback once, when the sprite is touched.

Parameters ​
NameType
uidstring
Returns ​

void

Defined in ​

client/rmlui/sprites/index.ts:55


height ​

• height: number

The height of the image. Pixels.

Defined in ​

client/rmlui/sprites/index.ts:40


path ​

• path: string

The path of the image we want to draw. Use @plugin/plugin-name/client/image.png for plugin based pathing. Otherwise paths are based on ../../../plugins/plugin-name/client/image.png.

Defined in ​

client/rmlui/sprites/index.ts:24


position ​

• position: IVector3

A position in-world, or on-screen where to draw this image.

Defined in ​

client/rmlui/sprites/index.ts:48


uid ​

• uid: string

A unique identifier for this sprite.

Defined in ​

client/rmlui/sprites/index.ts:14


width ​

• width: number

The width of the image. Pixels.

Defined in ​

client/rmlui/sprites/index.ts:32

Created by Stuyk | Est. 2020