getMenuEntry
getMenuEntry: (MenuOptionClicked) -> 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 menu has moved on since.
| Method | Returns | Description |
|---|---|---|
getMenuEntry() | 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… |
isConsumed() | boolean | Whether a subscriber consumed it. |
consume() | () | Stop the action: the client runs nothing for this click. |
getParam0() | number | The entry's first parameter. |
getParam1() | number | The entry's second parameter. |
getMenuOption() | string | The entry's option text. |
getMenuTarget() | string | The entry's target text. |
getMenuAction() | MenuAction | The entry's action. |
getId() | number | The entry's identifier: the object, actor or item the action targets. |
isItemOp() | boolean | Whether it is an inventory item op ("Use" and "Examine" are not). |
getItemOp() | number | The item op 1-5 of an inventory item op, else -1. |
getItemId() | number | The item id, or -1. |
getWidget() | Widget? | The widget the clicked entry acts on (getMenuEntry():getWidget()), or nil. |
getActionParam() | number | Deprecated: use getParam0(). |
getWidgetId() | number | Deprecated: use getParam1(). |
| Field | Type | Description |
|---|---|---|
__eventClass | string | "MenuOptionClicked": the class's name, which host APIs that take the class itself read. |
getMenuEntrygetMenuEntry: (MenuOptionClicked) -> 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 menu has moved on since.
isConsumedisConsumed: (MenuOptionClicked) -> booleanWhether a subscriber consumed it.
consumeconsume: (MenuOptionClicked) -> ()Stop the action: the client runs nothing for this click.
getParam0getParam0: (MenuOptionClicked) -> numberThe entry's first parameter.
getParam1getParam1: (MenuOptionClicked) -> numberThe entry's second parameter.
getMenuOptiongetMenuOption: (MenuOptionClicked) -> stringThe entry's option text.
getMenuTargetgetMenuTarget: (MenuOptionClicked) -> stringThe entry's target text.
getMenuActiongetMenuAction: (MenuOptionClicked) -> MenuActionThe entry's action.
getIdgetId: (MenuOptionClicked) -> numberThe entry's identifier: the object, actor or item the action targets.
isItemOpisItemOp: (MenuOptionClicked) -> booleanWhether it is an inventory item op ("Use" and "Examine" are not).
getItemOpgetItemOp: (MenuOptionClicked) -> numberThe item op 1-5 of an inventory item op, else -1.
getItemIdgetItemId: (MenuOptionClicked) -> numberThe item id, or -1.
getWidgetgetWidget: (MenuOptionClicked) -> Widget?The widget the clicked entry acts on (getMenuEntry():getWidget()), or nil.
getActionParamgetActionParam: (MenuOptionClicked) -> numberDeprecated: use getParam0().
getWidgetIdgetWidgetId: (MenuOptionClicked) -> numberDeprecated: use getParam1().