java.lang.Object
- com.runemate.game.api.hybrid.input.direct.MenuAction

public class MenuAction
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MenuAction.MenuActionBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MenuAction.MenuActionBuilder`	`builder()`
`static @Nullable MenuAction`	`forBankWithdrawal(@NonNull SpriteItem item, int quantity)`	Builds a MenuAction to withdraw an item from the bank.
`static @Nullable MenuAction`	`forGameObject(@NonNull GameObject obj, int action)`
`static @Nullable MenuAction`	`forGameObject(@NonNull GameObject obj, @NonNull java.lang.String action)`
`static @Nullable MenuAction`	`forGameObject(@NonNull GameObject obj, @NonNull java.util.regex.Pattern action)`
`static @Nullable MenuAction`	`forGameObject(@NonNull GameObject obj, MenuOpcode opcode)`
`static @Nullable MenuAction`	`forGroundItem(@NonNull GroundItem item, int action)`
`static @Nullable MenuAction`	`forGroundItem(@NonNull GroundItem item, @NonNull java.lang.String action)`
`static @Nullable MenuAction`	`forGroundItem(@NonNull GroundItem item, @NonNull java.util.regex.Pattern action)`
`static @Nullable MenuAction`	`forGroundItem(@NonNull GroundItem item, MenuOpcode opcode)`
`static @Nullable MenuAction`	`forInterfaceComponent(@NonNull InterfaceComponent component, int action)`
`static @Nullable MenuAction`	`forInterfaceComponent(@NonNull InterfaceComponent component, int action, MenuOpcode opcode)`
`static @Nullable MenuAction`	`forInterfaceComponent(@NonNull InterfaceComponent component, @NonNull java.lang.String action)`
`static @Nullable MenuAction`	`forInterfaceComponent(@NonNull InterfaceComponent component, @NonNull java.util.regex.Pattern action)`
`static @Nullable MenuAction`	`forNpc(@NonNull Npc npc, int action)`
`static @Nullable MenuAction`	`forNpc(@NonNull Npc npc, @NonNull java.lang.String action)`
`static @Nullable MenuAction`	`forNpc(@NonNull Npc npc, @NonNull java.util.regex.Pattern action)`
`static @Nullable MenuAction`	`forNpc(@NonNull Npc npc, MenuOpcode opcode)`
`static @Nullable MenuAction`	`forPlayer(@NonNull Player player, int action)`
`static @Nullable MenuAction`	`forPlayer(@NonNull Player player, @NonNull java.lang.String action)`
`static @Nullable MenuAction`	`forPlayer(@NonNull Player player, @NonNull java.util.regex.Pattern action)`
`static @Nullable MenuAction`	`forPlayer(@NonNull Player player, MenuOpcode opcode)`
`static @Nullable MenuAction`	`forSpriteItem(@NonNull InterfaceComponent component, @NonNull SpriteItem item, int action, MenuOpcode opcode)`
`static @Nullable MenuAction`	`forSpriteItem(@NonNull SpriteItem item, int action)`
`static @Nullable MenuAction`	`forSpriteItem(@NonNull SpriteItem item, int action, MenuOpcode opcode)`
`static @Nullable MenuAction`	`forSpriteItem(@NonNull SpriteItem item, @NonNull java.lang.String action)`
`static @Nullable MenuAction`	`forSpriteItem(@NonNull SpriteItem item, @NonNull java.util.regex.Pattern action)`
`Interactable`	`getEntity()`
`int`	`getIdentifier()`
`int`	`getItemId()`
`int`	`getOpcode()`
`java.lang.String`	`getOption()`
`int`	`getParam0()`
`int`	`getParam1()`
`static @Nullable InterfaceComponent`	`getSpriteItemComponent(@NonNull SpriteItem item)`
`java.lang.String`	`getTarget()`
`java.lang.String`	`toString()`

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

Method Detail

forInterfaceComponent

@Nullable
public static @Nullable MenuAction forInterfaceComponent(@NonNull
                                                         @NonNull InterfaceComponent component,
                                                         int action,
                                                         MenuOpcode opcode)

forInterfaceComponent

@Nullable
public static @Nullable MenuAction forInterfaceComponent(@NonNull
                                                         @NonNull InterfaceComponent component,
                                                         int action)

forInterfaceComponent

@Nullable
public static @Nullable MenuAction forInterfaceComponent(@NonNull
                                                         @NonNull InterfaceComponent component,
                                                         @NonNull
                                                         @NonNull java.lang.String action)

forInterfaceComponent

@Nullable
public static @Nullable MenuAction forInterfaceComponent(@NonNull
                                                         @NonNull InterfaceComponent component,
                                                         @NonNull
                                                         @NonNull java.util.regex.Pattern action)

forPlayer

@Nullable
public static @Nullable MenuAction forPlayer(@NonNull
                                             @NonNull Player player,
                                             MenuOpcode opcode)

forPlayer

@Nullable
public static @Nullable MenuAction forPlayer(@NonNull
                                             @NonNull Player player,
                                             int action)

forPlayer

@Nullable
public static @Nullable MenuAction forPlayer(@NonNull
                                             @NonNull Player player,
                                             @NonNull
                                             @NonNull java.lang.String action)

forPlayer

@Nullable
public static @Nullable MenuAction forPlayer(@NonNull
                                             @NonNull Player player,
                                             @NonNull
                                             @NonNull java.util.regex.Pattern action)

forNpc

@Nullable
public static @Nullable MenuAction forNpc(@NonNull
                                          @NonNull Npc npc,
                                          MenuOpcode opcode)

forNpc

@Nullable
public static @Nullable MenuAction forNpc(@NonNull
                                          @NonNull Npc npc,
                                          int action)

forNpc

@Nullable
public static @Nullable MenuAction forNpc(@NonNull
                                          @NonNull Npc npc,
                                          @NonNull
                                          @NonNull java.lang.String action)

forNpc

@Nullable
public static @Nullable MenuAction forNpc(@NonNull
                                          @NonNull Npc npc,
                                          @NonNull
                                          @NonNull java.util.regex.Pattern action)

forGameObject

@Nullable
public static @Nullable MenuAction forGameObject(@NonNull
                                                 @NonNull GameObject obj,
                                                 MenuOpcode opcode)

forGameObject

@Nullable
public static @Nullable MenuAction forGameObject(@NonNull
                                                 @NonNull GameObject obj,
                                                 int action)

forGameObject

@Nullable
public static @Nullable MenuAction forGameObject(@NonNull
                                                 @NonNull GameObject obj,
                                                 @NonNull
                                                 @NonNull java.lang.String action)

forGameObject

@Nullable
public static @Nullable MenuAction forGameObject(@NonNull
                                                 @NonNull GameObject obj,
                                                 @NonNull
                                                 @NonNull java.util.regex.Pattern action)

forGroundItem

@Nullable
public static @Nullable MenuAction forGroundItem(@NonNull
                                                 @NonNull GroundItem item,
                                                 MenuOpcode opcode)

forGroundItem

@Nullable
public static @Nullable MenuAction forGroundItem(@NonNull
                                                 @NonNull GroundItem item,
                                                 int action)

forGroundItem

@Nullable
public static @Nullable MenuAction forGroundItem(@NonNull
                                                 @NonNull GroundItem item,
                                                 @NonNull
                                                 @NonNull java.lang.String action)

forGroundItem

@Nullable
public static @Nullable MenuAction forGroundItem(@NonNull
                                                 @NonNull GroundItem item,
                                                 @NonNull
                                                 @NonNull java.util.regex.Pattern action)

forBankWithdrawal
```
@Nullable
public static @Nullable MenuAction forBankWithdrawal(@NonNull
                                                     @NonNull SpriteItem item,
                                                     int quantity)
```
Builds a MenuAction to withdraw an item from the bank.
Default quantities: -1 (All-but-1), 0 (All), 1, 5, 10
When using any quantity other than those listed above, the default withdraw quantity must be set before this action is built.

forSpriteItem

@Nullable
public static @Nullable MenuAction forSpriteItem(@NonNull
                                                 @NonNull InterfaceComponent component,
                                                 @NonNull
                                                 @NonNull SpriteItem item,
                                                 int action,
                                                 MenuOpcode opcode)

forSpriteItem

@Nullable
public static @Nullable MenuAction forSpriteItem(@NonNull
                                                 @NonNull SpriteItem item,
                                                 int action,
                                                 MenuOpcode opcode)

forSpriteItem

@Nullable
public static @Nullable MenuAction forSpriteItem(@NonNull
                                                 @NonNull SpriteItem item,
                                                 int action)

forSpriteItem

@Nullable
public static @Nullable MenuAction forSpriteItem(@NonNull
                                                 @NonNull SpriteItem item,
                                                 @NonNull
                                                 @NonNull java.lang.String action)

forSpriteItem

@Nullable
public static @Nullable MenuAction forSpriteItem(@NonNull
                                                 @NonNull SpriteItem item,
                                                 @NonNull
                                                 @NonNull java.util.regex.Pattern action)

getSpriteItemComponent

@Nullable
public static @Nullable InterfaceComponent getSpriteItemComponent(@NonNull
                                                                  @NonNull SpriteItem item)

builder

public static MenuAction.MenuActionBuilder builder()

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

getOption
```
public java.lang.String getOption()
```

getTarget
```
public java.lang.String getTarget()
```

getIdentifier
```
public int getIdentifier()
```

getParam0
```
public int getParam0()
```

getParam1
```
public int getParam1()
```

getOpcode
```
public int getOpcode()
```

getItemId
```
public int getItemId()
```

getEntity
```
public Interactable getEntity()
```

Class MenuAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forInterfaceComponent

forInterfaceComponent

forInterfaceComponent

forInterfaceComponent

forPlayer

forPlayer

forPlayer

forPlayer

forNpc

forNpc

forNpc

forNpc

forGameObject

forGameObject

forGameObject

forGameObject

forGroundItem

forGroundItem

forGroundItem

forGroundItem

forBankWithdrawal

forSpriteItem

forSpriteItem

forSpriteItem

forSpriteItem

forSpriteItem

getSpriteItemComponent

builder

toString

getOption

getTarget

getIdentifier

getParam0

getParam1

getOpcode

getItemId

getEntity