MenuOptionClicked

Methods
15
Fields
1

Methods

MethodReturnsDescription
getMenuEntry()MenuEntryThe clicked entry, live. From a legacy delivery (a build without the menu sites), a detached, read-only entry with the event's fields: the…
isConsumed()booleanWhether a subscriber consumed it.
consume()()Stop the action: the client runs nothing for this click.
getParam0()numberThe entry's first parameter.
getParam1()numberThe entry's second parameter.
getMenuOption()stringThe entry's option text.
getMenuTarget()stringThe entry's target text.
getMenuAction()MenuActionThe entry's action.
getId()numberThe entry's identifier: the object, actor or item the action targets.
isItemOp()booleanWhether it is an inventory item op ("Use" and "Examine" are not).
getItemOp()numberThe item op 1-5 of an inventory item op, else -1.
getItemId()numberThe item id, or -1.
getWidget()Widget?The widget the clicked entry acts on (getMenuEntry():getWidget()), or nil.
getActionParam()numberDeprecated: use getParam0().
getWidgetId()numberDeprecated: use getParam1().

Fields

FieldTypeDescription
__eventClassstring"MenuOptionClicked": the class's name, which host APIs that take the class itself read.

Method details

getMenuEntry

getMenuEntry: (MenuOptionClicked) -> MenuEntry

The clicked entry, live. From a legacy delivery (a build without the menu sites), a detached, read-only entry with the event's fields: the menu has moved on since.

getId

getId: (MenuOptionClicked) -> number

The entry's identifier: the object, actor or item the action targets.