ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

api: refactor some menu action names

Browse Source 
Replace spell cast with widget use and correct a couple of the other
names
This commit is contained in:
Adam
2022-04-16 15:53:47 -04:00
parent 93b6393625
commit c0a338519c
10 changed files with 49 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
runelite-api/src/main/java/net/runelite/api/MenuAction.java
View File

@@ -37,9 +37,9 @@ public enum MenuAction
*/ */
ITEM_USE_ON_GAME_OBJECT(1), ITEM_USE_ON_GAME_OBJECT(1),
/** /**
* Menu action for casting a spell on a tile object (GameObject or GroundObject). * Menu action for using a widget on a tile object (GameObject or GroundObject).
*/ */
SPELL_CAST_ON_GAME_OBJECT(2), WIDGET_TARGET_ON_GAME_OBJECT(2),
/** /**
* First menu action for a game object. * First menu action for a game object.
*/ */
@@ -66,9 +66,9 @@ public enum MenuAction
*/ */
ITEM_USE_ON_NPC(7), ITEM_USE_ON_NPC(7),
/** /**
* Menu action for casting a spell on an NPC. * Menu action for using a widget on an NPC.
*/ */
SPELL_CAST_ON_NPC(8), WIDGET_TARGET_ON_NPC(8),
/** /**
* First menu action for an NPC. * First menu action for an NPC.
*/ */
@@ -95,18 +95,18 @@ public enum MenuAction
*/ */
ITEM_USE_ON_PLAYER(14), ITEM_USE_ON_PLAYER(14),
/** /**
* Menu action for casting a spell on a player. * Menu action for using a widget on a player.
*/ */
SPELL_CAST_ON_PLAYER(15), WIDGET_TARGET_ON_PLAYER(15),
/** /**
* Menu action for using an item on an item on the ground. * Menu action for using an item on an item on the ground.
*/ */
ITEM_USE_ON_GROUND_ITEM(16), ITEM_USE_ON_GROUND_ITEM(16),
/** /**
* Menu action for casting a spell on an item on the ground. * Menu action for using a widget on an item on the ground.
*/ */
SPELL_CAST_ON_GROUND_ITEM(17), WIDGET_TARGET_ON_GROUND_ITEM(17),
/** /**
* First menu action for an item on the ground. * First menu action for an item on the ground.
*/ */
@@ -138,13 +138,13 @@ public enum MenuAction
*/ */
WIDGET_TYPE_1(24), WIDGET_TYPE_1(24),
/** /**
* Interaction with widget (type 2). * Select the widget for targeting other widgets/entites etc.
*/ */
WIDGET_TYPE_2(25), WIDGET_TARGET(25),
/** /**
* Interaction with widget (type 3). * Performs an ifclose.
*/ */
WIDGET_TYPE_3(26), WIDGET_CLOSE(26),
/** /**
* Interaction with widget (type 4). * Interaction with widget (type 4).
*/ */
@@ -154,17 +154,17 @@ public enum MenuAction
*/ */
WIDGET_TYPE_5(29), WIDGET_TYPE_5(29),
/** /**
* Interaction with widget (type 6). * Performs a Continue
*/ */
WIDGET_TYPE_6(30), WIDGET_CONTINUE(30),
/** /**
* Menu action when using an item on another item inside a widget (inventory). * Menu action when using an item on another item
*/ */
ITEM_USE_ON_WIDGET_ITEM(31), ITEM_USE_ON_ITEM(31),
/** /**
* Menu action when using an item on a widget. * Menu action when using a component on an item
*/ */
ITEM_USE_ON_WIDGET(32), WIDGET_USE_ON_ITEM(32),
/** /**
* First menu action for an item. * First menu action for an item.
@@ -227,9 +227,9 @@ public enum MenuAction
CC_OP(57), CC_OP(57),
/** /**
* Casting a spell / op target on a widget * Using a widget on another widget
*/ */
SPELL_CAST_ON_WIDGET(58), WIDGET_TARGET_ON_WIDGET(58),
/** /**
* Menu action for high priority runelite options * Menu action for high priority runelite options

8
runelite-client/src/main/java/net/runelite/client/plugins/devtools/WidgetInspector.java
View File

@@ -516,8 +516,8 @@ class WidgetInspector extends DevToolsFrame
for (int i = 0; i < menuEntries.length; i++) for (int i = 0; i < menuEntries.length; i++)
{ {
MenuEntry entry = menuEntries[i]; MenuEntry entry = menuEntries[i];
if (entry.getType() != MenuAction.ITEM_USE_ON_WIDGET if (entry.getType() != MenuAction.WIDGET_USE_ON_ITEM
&& entry.getType() != MenuAction.SPELL_CAST_ON_WIDGET) && entry.getType() != MenuAction.WIDGET_TARGET_ON_WIDGET)
{ {
continue; continue;
} }
@@ -543,7 +543,7 @@ class WidgetInspector extends DevToolsFrame
Object getWidgetOrWidgetItemForMenuOption(MenuAction type, int param0, int param1) Object getWidgetOrWidgetItemForMenuOption(MenuAction type, int param0, int param1)
{ {
if (type == MenuAction.SPELL_CAST_ON_WIDGET) if (type == MenuAction.WIDGET_TARGET_ON_WIDGET)
{ {
Widget w = client.getWidget(param1); Widget w = client.getWidget(param1);
if (param0 != -1) if (param0 != -1)
@@ -553,7 +553,7 @@ class WidgetInspector extends DevToolsFrame
return w; return w;
} }
else if (type == MenuAction.ITEM_USE_ON_WIDGET) else if (type == MenuAction.WIDGET_USE_ON_ITEM)
{ {
Widget w = client.getWidget(param1); Widget w = client.getWidget(param1);
return w.getWidgetItem(param0); return w.getWidgetItem(param0);

2
runelite-client/src/main/java/net/runelite/client/plugins/grounditems/GroundItemsPlugin.java
View File

@@ -485,7 +485,7 @@ public class GroundItemsPlugin extends Plugin
MenuAction type = MenuAction.of(event.getType()); MenuAction type = MenuAction.of(event.getType());
if (type == MenuAction.GROUND_ITEM_FIRST_OPTION || type == MenuAction.GROUND_ITEM_SECOND_OPTION || if (type == MenuAction.GROUND_ITEM_FIRST_OPTION || type == MenuAction.GROUND_ITEM_SECOND_OPTION ||
type == MenuAction.GROUND_ITEM_THIRD_OPTION || type == MenuAction.GROUND_ITEM_FOURTH_OPTION || type == MenuAction.GROUND_ITEM_THIRD_OPTION || type == MenuAction.GROUND_ITEM_FOURTH_OPTION ||
type == MenuAction.GROUND_ITEM_FIFTH_OPTION || type == MenuAction.SPELL_CAST_ON_GROUND_ITEM) type == MenuAction.GROUND_ITEM_FIFTH_OPTION || type == MenuAction.WIDGET_TARGET_ON_GROUND_ITEM)
{ {
final int itemId = event.getIdentifier(); final int itemId = event.getIdentifier();
final int sceneX = event.getActionParam0(); final int sceneX = event.getActionParam0();

6
runelite-client/src/main/java/net/runelite/client/plugins/interacthighlight/InteractHighlightOverlay.java
View File

@@ -85,7 +85,7 @@ class InteractHighlightOverlay extends Overlay
switch (menuAction) switch (menuAction)
{ {
case ITEM_USE_ON_GAME_OBJECT: case ITEM_USE_ON_GAME_OBJECT:
case SPELL_CAST_ON_GAME_OBJECT: case WIDGET_TARGET_ON_GAME_OBJECT:
case GAME_OBJECT_FIRST_OPTION: case GAME_OBJECT_FIRST_OPTION:
case GAME_OBJECT_SECOND_OPTION: case GAME_OBJECT_SECOND_OPTION:
case GAME_OBJECT_THIRD_OPTION: case GAME_OBJECT_THIRD_OPTION:
@@ -104,7 +104,7 @@ class InteractHighlightOverlay extends Overlay
break; break;
} }
case ITEM_USE_ON_NPC: case ITEM_USE_ON_NPC:
case SPELL_CAST_ON_NPC: case WIDGET_TARGET_ON_NPC:
case NPC_FIRST_OPTION: case NPC_FIRST_OPTION:
case NPC_SECOND_OPTION: case NPC_SECOND_OPTION:
case NPC_THIRD_OPTION: case NPC_THIRD_OPTION:
@@ -116,7 +116,7 @@ class InteractHighlightOverlay extends Overlay
NPC npc = plugin.findNpc(id); NPC npc = plugin.findNpc(id);
if (npc != null && config.npcShowHover() && (npc != plugin.getInteractedTarget() || !config.npcShowInteract())) if (npc != null && config.npcShowHover() && (npc != plugin.getInteractedTarget() || !config.npcShowInteract()))
{ {
Color highlightColor = menuAction == MenuAction.NPC_SECOND_OPTION || menuAction == MenuAction.SPELL_CAST_ON_NPC Color highlightColor = menuAction == MenuAction.NPC_SECOND_OPTION || menuAction == MenuAction.WIDGET_TARGET_ON_NPC
? config.npcAttackHoverHighlightColor() : config.npcHoverHighlightColor(); ? config.npcAttackHoverHighlightColor() : config.npcHoverHighlightColor();
modelOutlineRenderer.drawOutline(npc, config.borderWidth(), highlightColor, config.outlineFeather()); modelOutlineRenderer.drawOutline(npc, config.borderWidth(), highlightColor, config.outlineFeather());
} }

6
runelite-client/src/main/java/net/runelite/client/plugins/interacthighlight/InteractHighlightPlugin.java
View File

@@ -141,7 +141,7 @@ public class InteractHighlightPlugin extends Plugin
switch (menuOptionClicked.getMenuAction()) switch (menuOptionClicked.getMenuAction())
{ {
case ITEM_USE_ON_GAME_OBJECT: case ITEM_USE_ON_GAME_OBJECT:
case SPELL_CAST_ON_GAME_OBJECT: case WIDGET_TARGET_ON_GAME_OBJECT:
case GAME_OBJECT_FIRST_OPTION: case GAME_OBJECT_FIRST_OPTION:
case GAME_OBJECT_SECOND_OPTION: case GAME_OBJECT_SECOND_OPTION:
case GAME_OBJECT_THIRD_OPTION: case GAME_OBJECT_THIRD_OPTION:
@@ -158,7 +158,7 @@ public class InteractHighlightPlugin extends Plugin
break; break;
} }
case ITEM_USE_ON_NPC: case ITEM_USE_ON_NPC:
case SPELL_CAST_ON_NPC: case WIDGET_TARGET_ON_NPC:
case NPC_FIRST_OPTION: case NPC_FIRST_OPTION:
case NPC_SECOND_OPTION: case NPC_SECOND_OPTION:
case NPC_THIRD_OPTION: case NPC_THIRD_OPTION:
@@ -168,7 +168,7 @@ public class InteractHighlightPlugin extends Plugin
int id = menuOptionClicked.getId(); int id = menuOptionClicked.getId();
interactedObject = null; interactedObject = null;
interactedNpc = findNpc(id); interactedNpc = findNpc(id);
attacked = menuOptionClicked.getMenuAction() == MenuAction.NPC_SECOND_OPTION || menuOptionClicked.getMenuAction() == MenuAction.SPELL_CAST_ON_NPC; attacked = menuOptionClicked.getMenuAction() == MenuAction.NPC_SECOND_OPTION || menuOptionClicked.getMenuAction() == MenuAction.WIDGET_TARGET_ON_NPC;
clickTick = client.getTickCount(); clickTick = client.getTickCount();
gameCycle = client.getGameCycle(); gameCycle = client.getGameCycle();
break; break;

2
runelite-client/src/main/java/net/runelite/client/plugins/itemprices/ItemPricesOverlay.java
View File

@@ -98,7 +98,7 @@ class ItemPricesOverlay extends Overlay
// Tooltip action type handling // Tooltip action type handling
switch (action) switch (action)
{ {
case ITEM_USE_ON_WIDGET: case WIDGET_USE_ON_ITEM:
if (!config.showWhileAlching() || !isAlching) if (!config.showWhileAlching() || !isAlching)
{ {
break; break;

12
runelite-client/src/main/java/net/runelite/client/plugins/mousehighlight/MouseHighlightOverlay.java
View File

@@ -49,13 +49,13 @@ class MouseHighlightOverlay extends Overlay
*/ */
private static final Set<MenuAction> WIDGET_MENU_ACTIONS = ImmutableSet.of( private static final Set<MenuAction> WIDGET_MENU_ACTIONS = ImmutableSet.of(
MenuAction.WIDGET_TYPE_1, MenuAction.WIDGET_TYPE_1,
MenuAction.WIDGET_TYPE_2, MenuAction.WIDGET_TARGET,
MenuAction.WIDGET_TYPE_3, MenuAction.WIDGET_CLOSE,
MenuAction.WIDGET_TYPE_4, MenuAction.WIDGET_TYPE_4,
MenuAction.WIDGET_TYPE_5, MenuAction.WIDGET_TYPE_5,
MenuAction.WIDGET_TYPE_6, MenuAction.WIDGET_CONTINUE,
MenuAction.ITEM_USE_ON_WIDGET_ITEM, MenuAction.ITEM_USE_ON_ITEM,
MenuAction.ITEM_USE_ON_WIDGET, MenuAction.WIDGET_USE_ON_ITEM,
MenuAction.ITEM_FIRST_OPTION, MenuAction.ITEM_FIRST_OPTION,
MenuAction.ITEM_SECOND_OPTION, MenuAction.ITEM_SECOND_OPTION,
MenuAction.ITEM_THIRD_OPTION, MenuAction.ITEM_THIRD_OPTION,
@@ -68,7 +68,7 @@ class MouseHighlightOverlay extends Overlay
MenuAction.WIDGET_FOURTH_OPTION, MenuAction.WIDGET_FOURTH_OPTION,
MenuAction.WIDGET_FIFTH_OPTION, MenuAction.WIDGET_FIFTH_OPTION,
MenuAction.EXAMINE_ITEM, MenuAction.EXAMINE_ITEM,
MenuAction.SPELL_CAST_ON_WIDGET, MenuAction.WIDGET_TARGET_ON_WIDGET,
MenuAction.CC_OP_LOW_PRIORITY, MenuAction.CC_OP_LOW_PRIORITY,
MenuAction.CC_OP MenuAction.CC_OP
); );

2
runelite-client/src/main/java/net/runelite/client/plugins/npchighlight/NpcIndicatorsPlugin.java
View File

@@ -90,7 +90,7 @@ public class NpcIndicatorsPlugin extends Plugin
private static final String UNTAG_ALL = "Un-tag-All"; private static final String UNTAG_ALL = "Un-tag-All";
private static final Set<MenuAction> NPC_MENU_ACTIONS = ImmutableSet.of(MenuAction.NPC_FIRST_OPTION, MenuAction.NPC_SECOND_OPTION, private static final Set<MenuAction> NPC_MENU_ACTIONS = ImmutableSet.of(MenuAction.NPC_FIRST_OPTION, MenuAction.NPC_SECOND_OPTION,
MenuAction.NPC_THIRD_OPTION, MenuAction.NPC_FOURTH_OPTION, MenuAction.NPC_FIFTH_OPTION, MenuAction.SPELL_CAST_ON_NPC, MenuAction.NPC_THIRD_OPTION, MenuAction.NPC_FOURTH_OPTION, MenuAction.NPC_FIFTH_OPTION, MenuAction.WIDGET_TARGET_ON_NPC,
MenuAction.ITEM_USE_ON_NPC); MenuAction.ITEM_USE_ON_NPC);
@Inject @Inject

4
runelite-client/src/main/java/net/runelite/client/plugins/playerindicators/PlayerIndicatorsPlugin.java
View File

@@ -42,7 +42,7 @@ import static net.runelite.api.MenuAction.PLAYER_SEVENTH_OPTION;
import static net.runelite.api.MenuAction.PLAYER_SIXTH_OPTION; import static net.runelite.api.MenuAction.PLAYER_SIXTH_OPTION;
import static net.runelite.api.MenuAction.PLAYER_THIRD_OPTION; import static net.runelite.api.MenuAction.PLAYER_THIRD_OPTION;
import static net.runelite.api.MenuAction.RUNELITE_PLAYER; import static net.runelite.api.MenuAction.RUNELITE_PLAYER;
import static net.runelite.api.MenuAction.SPELL_CAST_ON_PLAYER; import static net.runelite.api.MenuAction.WIDGET_TARGET_ON_PLAYER;
import static net.runelite.api.MenuAction.WALK; import static net.runelite.api.MenuAction.WALK;
import net.runelite.api.MenuEntry; import net.runelite.api.MenuEntry;
import net.runelite.api.Player; import net.runelite.api.Player;
@@ -124,7 +124,7 @@ public class PlayerIndicatorsPlugin extends Plugin
MenuAction type = entry.getType(); MenuAction type = entry.getType();
if (type == WALK if (type == WALK
|| type == SPELL_CAST_ON_PLAYER || type == WIDGET_TARGET_ON_PLAYER
|| type == ITEM_USE_ON_PLAYER || type == ITEM_USE_ON_PLAYER
|| type == PLAYER_FIRST_OPTION || type == PLAYER_FIRST_OPTION
|| type == PLAYER_SECOND_OPTION || type == PLAYER_SECOND_OPTION

16
runelite-client/src/main/java/net/runelite/client/plugins/wiki/WikiPlugin.java
View File

@@ -266,8 +266,8 @@ public class WikiPlugin extends Plugin
break optarget; break optarget;
case CANCEL: case CANCEL:
return; return;
case ITEM_USE_ON_WIDGET: case WIDGET_USE_ON_ITEM:
case SPELL_CAST_ON_GROUND_ITEM: case WIDGET_TARGET_ON_GROUND_ITEM:
{ {
type = "item"; type = "item";
id = itemManager.canonicalize(ev.getId()); id = itemManager.canonicalize(ev.getId());
@@ -275,7 +275,7 @@ public class WikiPlugin extends Plugin
location = null; location = null;
break; break;
} }
case SPELL_CAST_ON_NPC: case WIDGET_TARGET_ON_NPC:
{ {
type = "npc"; type = "npc";
NPC npc = client.getCachedNPCs()[ev.getId()]; NPC npc = client.getCachedNPCs()[ev.getId()];
@@ -285,7 +285,7 @@ public class WikiPlugin extends Plugin
location = npc.getWorldLocation(); location = npc.getWorldLocation();
break; break;
} }
case SPELL_CAST_ON_GAME_OBJECT: case WIDGET_TARGET_ON_GAME_OBJECT:
{ {
type = "object"; type = "object";
ObjectComposition lc = client.getObjectDefinition(ev.getId()); ObjectComposition lc = client.getObjectDefinition(ev.getId());
@@ -298,7 +298,7 @@ public class WikiPlugin extends Plugin
location = WorldPoint.fromScene(client, ev.getParam0(), ev.getParam1(), client.getPlane()); location = WorldPoint.fromScene(client, ev.getParam0(), ev.getParam1(), client.getPlane());
break; break;
} }
case SPELL_CAST_ON_WIDGET: case WIDGET_TARGET_ON_WIDGET:
Widget w = getWidget(ev.getParam1(), ev.getParam0()); Widget w = getWidget(ev.getParam1(), ev.getParam0());
if (w.getType() == WidgetType.GRAPHIC && w.getItemId() != -1) if (w.getType() == WidgetType.GRAPHIC && w.getItemId() != -1)
@@ -359,7 +359,7 @@ public class WikiPlugin extends Plugin
int widgetIndex = event.getActionParam0(); int widgetIndex = event.getActionParam0();
int widgetID = event.getActionParam1(); int widgetID = event.getActionParam1();
if (wikiSelected && event.getType() == MenuAction.SPELL_CAST_ON_WIDGET.getId()) if (wikiSelected && event.getType() == MenuAction.WIDGET_TARGET_ON_WIDGET.getId())
{ {
MenuEntry[] menuEntries = client.getMenuEntries(); MenuEntry[] menuEntries = client.getMenuEntries();
Widget w = getWidget(widgetID, widgetIndex); Widget w = getWidget(widgetID, widgetIndex);
@@ -368,7 +368,7 @@ public class WikiPlugin extends Plugin
for (int ourEntry = menuEntries.length - 1;ourEntry >= 0; ourEntry--) for (int ourEntry = menuEntries.length - 1;ourEntry >= 0; ourEntry--)
{ {
MenuEntry entry = menuEntries[ourEntry]; MenuEntry entry = menuEntries[ourEntry];
if (entry.getType() == MenuAction.SPELL_CAST_ON_WIDGET) if (entry.getType() == MenuAction.WIDGET_TARGET_ON_WIDGET)
{ {
int id = itemManager.canonicalize(w.getItemId()); int id = itemManager.canonicalize(w.getItemId());
String name = itemManager.getItemComposition(id).getName(); String name = itemManager.getItemComposition(id).getName();
@@ -385,7 +385,7 @@ public class WikiPlugin extends Plugin
MenuEntry[] oldEntries = menuEntries; MenuEntry[] oldEntries = menuEntries;
menuEntries = Arrays.copyOf(menuEntries, menuEntries.length - 1); menuEntries = Arrays.copyOf(menuEntries, menuEntries.length - 1);
for (int ourEntry = oldEntries.length - 1; for (int ourEntry = oldEntries.length - 1;
ourEntry >= 2 && oldEntries[oldEntries.length - 1].getType() != MenuAction.SPELL_CAST_ON_WIDGET; ourEntry >= 2 && oldEntries[oldEntries.length - 1].getType() != MenuAction.WIDGET_TARGET_ON_WIDGET;
ourEntry--) ourEntry--)
{ {
menuEntries[ourEntry - 1] = oldEntries[ourEntry]; menuEntries[ourEntry - 1] = oldEntries[ourEntry];