EmoteWheel

const EmoteWheel: object

Defined in: client/api.d.ts:3317

Which gesture each slot of this client’s emote wheel chooses.

The wheel has a fixed number of slots, numbered clockwise from the one straight up, and each chooses one row of the shipped catalog. They start out as the stock wheel – wave, big wave, nod, respectful nod, bow, cheer – and stay that way until a script changes them. A change is drawn on the next frame, including on a wheel held open.

Client-only and local: this arranges the wheel on this machine and nothing else. Every client can already play every gesture in the catalog, so a slot changes what is within reach, not what is allowed. The layout lasts for the session, and the next one starts from the default.

Type Declaration

getCatalog()

getCatalog(): EmoteCatalogEntry[]

Every gesture a slot can choose.

Returns

EmoteCatalogEntry[]

The catalog, in its own order.

getSlotCount()

getSlotCount(): number

How many slots the wheel has.

Returns

number

The slot count, which the catalog growing does not change.

getSlots()

getSlots(): number[]

The catalog id each slot chooses, in slot order.

Returns

number[]

One id per slot.

reset()

reset(): void

Puts every slot back to the stock wheel: wave, big wave, nod, respectful nod, bow, cheer.

Returns

void

setSlot()

setSlot(slot, emoteId): boolean

Points one slot at a catalog gesture. The same gesture may sit in more than one slot.

Parameters

slot

number

Zero-based, clockwise from straight up.

emoteId

number

An id from getCatalog.

Returns

boolean

False, and nothing changes, when the slot is out of range or the id is not in the catalog.

setSlots()

setSlots(emoteIds): boolean

Lays out the whole wheel at once.

Parameters

emoteIds

number[]

One catalog id per slot, in slot order; exactly getSlotCount() of them.

Returns

boolean

False, and nothing changes, when the list is the wrong length or any id is not in the catalog.