Classes

PopupMenu

This class is for interacting with context menus (i.e. when you single click on an item or your self). PopupMenu is available via the popupMenu variable on the global scope.

Example

popupMenu.request(player.serial);
popupMenu.waitUntilOpen(1000); // Wait 1 second for the menu to open
popupMenu.reply(0); // 0 is first item, second item is 1, etc.

Properties

content

content: any;

Get the menu content if it is open

---

exists

exists: boolean;

Checks if a popup currently exists

Methods

close()

close(): void

Closes a popup menu if it exists

---

reply()

reply(index: number): void

Replies to a popup menu. Index 0 is the first item.

Parameters

Parameter	Type	Description
index	number

---

request()

request(serial: number, waitMs?: number): undefined | boolean

Requests a popup menu for the given object

Parameters

Parameter	Type	Description
serial	number
waitMs?	number

Returns

undefined | boolean

---

waitForContent()

waitForContent(timeoutMs?: number): null | object

Wait until a popup context menu is open, and return its content or null

Parameters

Parameter	Type	Description
timeoutMs?	number

Returns

null | object

---

waitUntilOpen()

waitUntilOpen(timeoutMs?: number): boolean

Wait until a popup context menu is open

Parameters

Parameter	Type	Description
timeoutMs?	number

Returns

boolean