MenuAction (RuneLite API 1.5.28 API)

java.lang.Object
- java.lang.Enum<MenuAction>
- - net.runelite.api.MenuAction

All Implemented Interfaces:

Serializable, Comparable<MenuAction>
```
public enum MenuAction
extends Enum<MenuAction>
```
An enumeration of right-click menu actions.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CANCEL` Menu action triggered by canceling a menu.
`EXAMINE_ITEM` Menu action triggered by examining item in inventory.
`EXAMINE_ITEM_BANK_EQ` Menu action triggered by either examining item in bank, examining item in inventory while having bank open, or examining equipped item.
`EXAMINE_ITEM_GROUND` Menu action triggered by examining item on ground.
`EXAMINE_NPC` Menu action triggered by examining an NPC.
`EXAMINE_OBJECT` Menu action triggered by examining an object.
`FOLLOW`
`GAME_OBJECT_FIFTH_OPTION` Fifth menu action for a game object.
`GAME_OBJECT_FIRST_OPTION` First menu action for a game object.
`GAME_OBJECT_FOURTH_OPTION` Fourth menu action for a game object.
`GAME_OBJECT_SECOND_OPTION` Second menu action for a game object.
`GAME_OBJECT_THIRD_OPTION` Third menu action for a game object.
`GROUND_ITEM_FIFTH_OPTION` Fifth menu action for an item on the ground.
`GROUND_ITEM_FIRST_OPTION` First menu action for an item on the ground.
`GROUND_ITEM_FOURTH_OPTION` Fourth menu action for an item on the ground.
`GROUND_ITEM_SECOND_OPTION` Second menu action for an item on the ground.
`GROUND_ITEM_THIRD_OPTION` Third menu action for an item on the ground.
`ITEM_DROP` Menu action to drop an item (identical to ITEM_FIFTH_OPTION).
`ITEM_FIFTH_OPTION` Fifth menu action for an item.
`ITEM_FIRST_OPTION` First menu action for an item.
`ITEM_FOURTH_OPTION` Fourth menu action for an item.
`ITEM_SECOND_OPTION` Second menu action for an item.
`ITEM_THIRD_OPTION` Third menu action for an item.
`ITEM_USE` Menu action to use an item.
`ITEM_USE_ON_GAME_OBJECT` Menu action for using an item in your inventory on a tile object (GameObject or GroundObject).
`ITEM_USE_ON_GROUND_ITEM` Menu action for using an item on an item on the ground.
`ITEM_USE_ON_NPC` Menu action for using an item in your inventory on an NPC.
`ITEM_USE_ON_PLAYER` Menu action for using an item on a player.
`ITEM_USE_ON_WIDGET` Menu action when using an item on a widget.
`ITEM_USE_ON_WIDGET_ITEM` Menu action when using an item on another item inside a widget (inventory).
`NPC_FIFTH_OPTION` Fifth menu action for an NPC.
`NPC_FIRST_OPTION` First menu action for an NPC.
`NPC_FOURTH_OPTION` Fourth menu action for an NPC.
`NPC_SECOND_OPTION` Second menu action for an NPC.
`NPC_THIRD_OPTION` Third menu action for an NPC.
`PLAYER_EIGTH_OPTION`
`PLAYER_FIFTH_OPTION`
`PLAYER_FIRST_OPTION`
`PLAYER_FOURTH_OPTION`
`PLAYER_SECOND_OPTION`
`PLAYER_SEVENTH_OPTION`
`PLAYER_SIXTH_OPTION`
`PLAYER_THIRD_OPTION`
`RUNELITE` Menu action injected by runelite for its menu items.
`RUNELITE_OVERLAY` Menu action injected by runelite for overlay menu items.
`RUNELITE_OVERLAY_CONFIG` Menu action for configuring runelite overlays.
`SPELL_CAST_ON_GAME_OBJECT` Menu action for casting a spell on a tile object (GameObject or GroundObject).
`SPELL_CAST_ON_GROUND_ITEM` Menu action for casting a spell on an item on the ground.
`SPELL_CAST_ON_NPC` Menu action for casting a spell on an NPC.
`SPELL_CAST_ON_PLAYER` Menu action for casting a spell on a player.
`TRADE`
`UNKNOWN` Menu action triggered when the id is not defined in this class.
`WALK` Menu action for walking.
`WIDGET_DEFAULT` Default menu action for a widget.
`WIDGET_FIFTH_OPTION` Fifth menu action for a widget.
`WIDGET_FIRST_OPTION` First menu action for a widget.
`WIDGET_FOURTH_OPTION` Fourth menu action for a widget.
`WIDGET_SECOND_OPTION` Second menu action for a widget.
`WIDGET_THIRD_OPTION` Third menu action for a widget.
`WIDGET_TYPE_1` Interaction with widget (type 1).
`WIDGET_TYPE_2` Interaction with widget (type 2).
`WIDGET_TYPE_3` Interaction with widget (type 3).
`WIDGET_TYPE_4` Interaction with widget (type 4).
`WIDGET_TYPE_5` Interaction with widget (type 5).
`WIDGET_TYPE_6` Interaction with widget (type 6).

Field Summary

Fields
Modifier and Type Field and Description

static int MENU_ACTION_DEPRIORITIZE_OFFSET

Fields
Modifier and Type	Field and Description
`static int`	`MENU_ACTION_DEPRIORITIZE_OFFSET`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getId()`
`static MenuAction`	`of(int id)`
`static MenuAction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MenuAction[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ITEM_USE_ON_GAME_OBJECT
```
public static final MenuAction ITEM_USE_ON_GAME_OBJECT
```
    Menu action for using an item in your inventory on a tile object (GameObject or GroundObject).
  - SPELL_CAST_ON_GAME_OBJECT
```
public static final MenuAction SPELL_CAST_ON_GAME_OBJECT
```
    Menu action for casting a spell on a tile object (GameObject or GroundObject).
  - GAME_OBJECT_FIRST_OPTION
```
public static final MenuAction GAME_OBJECT_FIRST_OPTION
```
    First menu action for a game object.
  - GAME_OBJECT_SECOND_OPTION
```
public static final MenuAction GAME_OBJECT_SECOND_OPTION
```
    Second menu action for a game object.
  - GAME_OBJECT_THIRD_OPTION
```
public static final MenuAction GAME_OBJECT_THIRD_OPTION
```
    Third menu action for a game object.
  - GAME_OBJECT_FOURTH_OPTION
```
public static final MenuAction GAME_OBJECT_FOURTH_OPTION
```
    Fourth menu action for a game object.
  - GAME_OBJECT_FIFTH_OPTION
```
public static final MenuAction GAME_OBJECT_FIFTH_OPTION
```
    Fifth menu action for a game object.
  - ITEM_USE_ON_NPC
```
public static final MenuAction ITEM_USE_ON_NPC
```
    Menu action for using an item in your inventory on an NPC.
  - SPELL_CAST_ON_NPC
```
public static final MenuAction SPELL_CAST_ON_NPC
```
    Menu action for casting a spell on an NPC.
  - NPC_FIRST_OPTION
```
public static final MenuAction NPC_FIRST_OPTION
```
    First menu action for an NPC.
  - NPC_SECOND_OPTION
```
public static final MenuAction NPC_SECOND_OPTION
```
    Second menu action for an NPC.
  - NPC_THIRD_OPTION
```
public static final MenuAction NPC_THIRD_OPTION
```
    Third menu action for an NPC.
  - NPC_FOURTH_OPTION
```
public static final MenuAction NPC_FOURTH_OPTION
```
    Fourth menu action for an NPC.
  - NPC_FIFTH_OPTION
```
public static final MenuAction NPC_FIFTH_OPTION
```
    Fifth menu action for an NPC.
  - ITEM_USE_ON_PLAYER
```
public static final MenuAction ITEM_USE_ON_PLAYER
```
    Menu action for using an item on a player.
  - SPELL_CAST_ON_PLAYER
```
public static final MenuAction SPELL_CAST_ON_PLAYER
```
    Menu action for casting a spell on a player.
  - ITEM_USE_ON_GROUND_ITEM
```
public static final MenuAction ITEM_USE_ON_GROUND_ITEM
```
    Menu action for using an item on an item on the ground.
  - SPELL_CAST_ON_GROUND_ITEM
```
public static final MenuAction SPELL_CAST_ON_GROUND_ITEM
```
    Menu action for casting a spell on an item on the ground.
  - GROUND_ITEM_FIRST_OPTION
```
public static final MenuAction GROUND_ITEM_FIRST_OPTION
```
    First menu action for an item on the ground.
  - GROUND_ITEM_SECOND_OPTION
```
public static final MenuAction GROUND_ITEM_SECOND_OPTION
```
    Second menu action for an item on the ground.
  - GROUND_ITEM_THIRD_OPTION
```
public static final MenuAction GROUND_ITEM_THIRD_OPTION
```
    Third menu action for an item on the ground.
  - GROUND_ITEM_FOURTH_OPTION
```
public static final MenuAction GROUND_ITEM_FOURTH_OPTION
```
    Fourth menu action for an item on the ground.
  - GROUND_ITEM_FIFTH_OPTION
```
public static final MenuAction GROUND_ITEM_FIFTH_OPTION
```
    Fifth menu action for an item on the ground.
  - WALK
```
public static final MenuAction WALK
```
    Menu action for walking.
  - WIDGET_TYPE_1
```
public static final MenuAction WIDGET_TYPE_1
```
    Interaction with widget (type 1).
  - WIDGET_TYPE_2
```
public static final MenuAction WIDGET_TYPE_2
```
    Interaction with widget (type 2).
  - WIDGET_TYPE_3
```
public static final MenuAction WIDGET_TYPE_3
```
    Interaction with widget (type 3).
  - WIDGET_TYPE_4
```
public static final MenuAction WIDGET_TYPE_4
```
    Interaction with widget (type 4).
  - WIDGET_TYPE_5
```
public static final MenuAction WIDGET_TYPE_5
```
    Interaction with widget (type 5).
  - WIDGET_TYPE_6
```
public static final MenuAction WIDGET_TYPE_6
```
    Interaction with widget (type 6).
  - ITEM_USE_ON_WIDGET_ITEM
```
public static final MenuAction ITEM_USE_ON_WIDGET_ITEM
```
    Menu action when using an item on another item inside a widget (inventory).
  - ITEM_USE_ON_WIDGET
```
public static final MenuAction ITEM_USE_ON_WIDGET
```
    Menu action when using an item on a widget.
  - ITEM_FIRST_OPTION
```
public static final MenuAction ITEM_FIRST_OPTION
```
    First menu action for an item.
  - ITEM_SECOND_OPTION
```
public static final MenuAction ITEM_SECOND_OPTION
```
    Second menu action for an item.
  - ITEM_THIRD_OPTION
```
public static final MenuAction ITEM_THIRD_OPTION
```
    Third menu action for an item.
  - ITEM_FOURTH_OPTION
```
public static final MenuAction ITEM_FOURTH_OPTION
```
    Fourth menu action for an item.
  - ITEM_FIFTH_OPTION
```
public static final MenuAction ITEM_FIFTH_OPTION
```
    Fifth menu action for an item.
  - ITEM_DROP
```
public static final MenuAction ITEM_DROP
```
    Menu action to drop an item (identical to ITEM_FIFTH_OPTION).
  - ITEM_USE
```
public static final MenuAction ITEM_USE
```
    Menu action to use an item.
  - WIDGET_FIRST_OPTION
```
public static final MenuAction WIDGET_FIRST_OPTION
```
    First menu action for a widget.
  - WIDGET_SECOND_OPTION
```
public static final MenuAction WIDGET_SECOND_OPTION
```
    Second menu action for a widget.
  - WIDGET_THIRD_OPTION
```
public static final MenuAction WIDGET_THIRD_OPTION
```
    Third menu action for a widget.
  - WIDGET_FOURTH_OPTION
```
public static final MenuAction WIDGET_FOURTH_OPTION
```
    Fourth menu action for a widget.
  - WIDGET_FIFTH_OPTION
```
public static final MenuAction WIDGET_FIFTH_OPTION
```
    Fifth menu action for a widget.
  - PLAYER_FIRST_OPTION
```
public static final MenuAction PLAYER_FIRST_OPTION
```
  - PLAYER_SECOND_OPTION
```
public static final MenuAction PLAYER_SECOND_OPTION
```
  - PLAYER_THIRD_OPTION
```
public static final MenuAction PLAYER_THIRD_OPTION
```
  - PLAYER_FOURTH_OPTION
```
public static final MenuAction PLAYER_FOURTH_OPTION
```
  - PLAYER_FIFTH_OPTION
```
public static final MenuAction PLAYER_FIFTH_OPTION
```
  - PLAYER_SIXTH_OPTION
```
public static final MenuAction PLAYER_SIXTH_OPTION
```
  - PLAYER_SEVENTH_OPTION
```
public static final MenuAction PLAYER_SEVENTH_OPTION
```
  - PLAYER_EIGTH_OPTION
```
public static final MenuAction PLAYER_EIGTH_OPTION
```
  - WIDGET_DEFAULT
```
public static final MenuAction WIDGET_DEFAULT
```
    Default menu action for a widget.
  - EXAMINE_OBJECT
```
public static final MenuAction EXAMINE_OBJECT
```
    Menu action triggered by examining an object.
  - EXAMINE_NPC
```
public static final MenuAction EXAMINE_NPC
```
    Menu action triggered by examining an NPC.
  - EXAMINE_ITEM_GROUND
```
public static final MenuAction EXAMINE_ITEM_GROUND
```
    Menu action triggered by examining item on ground.
  - EXAMINE_ITEM
```
public static final MenuAction EXAMINE_ITEM
```
    Menu action triggered by examining item in inventory.
  - CANCEL
```
public static final MenuAction CANCEL
```
    Menu action triggered by canceling a menu.
  - EXAMINE_ITEM_BANK_EQ
```
public static final MenuAction EXAMINE_ITEM_BANK_EQ
```
    Menu action triggered by either examining item in bank, examining item in inventory while having bank open, or examining equipped item.
  - RUNELITE
```
public static final MenuAction RUNELITE
```
    Menu action injected by runelite for its menu items.
  - RUNELITE_OVERLAY
```
public static final MenuAction RUNELITE_OVERLAY
```
    Menu action injected by runelite for overlay menu items.
  - RUNELITE_OVERLAY_CONFIG
```
public static final MenuAction RUNELITE_OVERLAY_CONFIG
```
    Menu action for configuring runelite overlays.
  - FOLLOW
```
public static final MenuAction FOLLOW
```
  - TRADE
```
public static final MenuAction TRADE
```
  - UNKNOWN
```
public static final MenuAction UNKNOWN
```
    Menu action triggered when the id is not defined in this class.
- Field Detail
  - MENU_ACTION_DEPRIORITIZE_OFFSET
```
public static final int MENU_ACTION_DEPRIORITIZE_OFFSET
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static MenuAction[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MenuAction c : MenuAction.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MenuAction valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getId
```
public int getId()
```
  - of
```
public static MenuAction of(int id)
```

Enum MenuAction

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ITEM_USE_ON_GAME_OBJECT

SPELL_CAST_ON_GAME_OBJECT

GAME_OBJECT_FIRST_OPTION

GAME_OBJECT_SECOND_OPTION

GAME_OBJECT_THIRD_OPTION

GAME_OBJECT_FOURTH_OPTION

GAME_OBJECT_FIFTH_OPTION

ITEM_USE_ON_NPC

SPELL_CAST_ON_NPC

NPC_FIRST_OPTION

NPC_SECOND_OPTION

NPC_THIRD_OPTION

NPC_FOURTH_OPTION

NPC_FIFTH_OPTION

ITEM_USE_ON_PLAYER

SPELL_CAST_ON_PLAYER

ITEM_USE_ON_GROUND_ITEM

SPELL_CAST_ON_GROUND_ITEM

GROUND_ITEM_FIRST_OPTION

GROUND_ITEM_SECOND_OPTION

GROUND_ITEM_THIRD_OPTION

GROUND_ITEM_FOURTH_OPTION

GROUND_ITEM_FIFTH_OPTION

WALK

WIDGET_TYPE_1

WIDGET_TYPE_2

WIDGET_TYPE_3

WIDGET_TYPE_4

WIDGET_TYPE_5

WIDGET_TYPE_6

ITEM_USE_ON_WIDGET_ITEM

ITEM_USE_ON_WIDGET

ITEM_FIRST_OPTION

ITEM_SECOND_OPTION

ITEM_THIRD_OPTION

ITEM_FOURTH_OPTION

ITEM_FIFTH_OPTION

ITEM_DROP

ITEM_USE

WIDGET_FIRST_OPTION

WIDGET_SECOND_OPTION

WIDGET_THIRD_OPTION

WIDGET_FOURTH_OPTION

WIDGET_FIFTH_OPTION

PLAYER_FIRST_OPTION

PLAYER_SECOND_OPTION

PLAYER_THIRD_OPTION

PLAYER_FOURTH_OPTION

PLAYER_FIFTH_OPTION

PLAYER_SIXTH_OPTION

PLAYER_SEVENTH_OPTION

PLAYER_EIGTH_OPTION

WIDGET_DEFAULT

EXAMINE_OBJECT

EXAMINE_NPC

EXAMINE_ITEM_GROUND

EXAMINE_ITEM

CANCEL

EXAMINE_ITEM_BANK_EQ

RUNELITE

RUNELITE_OVERLAY

RUNELITE_OVERLAY_CONFIG

FOLLOW

TRADE

UNKNOWN

Field Detail

MENU_ACTION_DEPRIORITIZE_OFFSET

Method Detail

values

valueOf

getId

of