Updated Runecraft Plugin

- Lava Rune Changes:
 - Added many menu swaps to make the process entirely left click
- Overlay added notifying broken pouch
- Issue: Easyscape has to be turned off or conflicts turned off to work with lava rune menuentry changes.
This commit is contained in:
lulwut
2019-05-17 11:10:56 +12:00
parent 2eada0a123
commit 1d0bdf9615
4 changed files with 151 additions and 145 deletions

View File

@@ -24,7 +24,7 @@
*/ */
package net.runelite.client.plugins.runecraft; package net.runelite.client.plugins.runecraft;
import com.google.common.collect.ImmutableMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import lombok.Getter; import lombok.Getter;
import static net.runelite.api.ItemID.AIR_RUNE; import static net.runelite.api.ItemID.AIR_RUNE;
@@ -64,18 +64,14 @@ public enum AbyssRifts
@Getter @Getter
private final int itemId; private final int itemId;
private static final Map<Integer, AbyssRifts> rifts; private static final Map<Integer, AbyssRifts> rifts = new HashMap<>();
static static
{ {
ImmutableMap.Builder<Integer, AbyssRifts> builder = new ImmutableMap.Builder<>();
for (AbyssRifts s : values()) for (AbyssRifts s : values())
{ {
builder.put(s.getObjectId(), s); rifts.put(s.getObjectId(), s);
} }
rifts = builder.build();
} }
AbyssRifts(int objectId, int itemId) AbyssRifts(int objectId, int itemId)

View File

@@ -219,11 +219,11 @@ public interface RunecraftConfig extends Config
return true; return true;
} }
@ConfigItem( @ConfigItem(
keyName = "opLavas", keyName = "Lavas",
name = "Op lavas", name = "Lavas",
description = "Op orange dorito mode - Only does something if you're wearing fire tiara" description = "Swaps Ring of dueling menu entry depending on location, requires fire tiara or RC cape to be worn."
) )
default boolean opLavas() default boolean Lavas()
{ {
return true; return true;
} }

View File

@@ -0,0 +1,41 @@
package net.runelite.client.plugins.runecraft;
import net.runelite.api.Client;
import net.runelite.client.ui.overlay.Overlay;
import net.runelite.client.ui.overlay.OverlayPosition;
import net.runelite.client.ui.overlay.components.ComponentOrientation;
import net.runelite.client.ui.overlay.components.LineComponent;
import net.runelite.client.ui.overlay.components.PanelComponent;
import net.runelite.client.ui.overlay.components.TitleComponent;
import javax.inject.Inject;
import java.awt.*;
public class RunecraftOverlay extends Overlay {
private final RunecraftPlugin plugin;
private final Client client;
private final PanelComponent panel = new PanelComponent();
@Inject
RunecraftOverlay(RunecraftPlugin plugin, Client client) {
this.plugin = plugin;
this.client = client;
setPosition(OverlayPosition.CANVAS_TOP_RIGHT);
panel.setOrientation(ComponentOrientation.VERTICAL);
}
public Dimension render(Graphics2D graphics) {
String text = "Pouch Has Degraded";
panel.getChildren().clear();
if(plugin.isDegradedPouchInInventory()) {
panel.getChildren().add(TitleComponent.builder()
.text("Pouch Has Degraded")
.color(Color.red)
.build());
panel.setPreferredSize(new Dimension(graphics.getFontMetrics().stringWidth(text)+5, 5));
return panel.render(graphics);
} else {
return null;
}
}
}

View File

@@ -26,64 +26,58 @@ package net.runelite.client.plugins.runecraft;
import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableList;
import com.google.inject.Provides; import com.google.inject.Provides;
import java.util.Arrays;
import java.util.HashSet; import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Set; import java.util.Set;
import java.util.stream.Stream; import java.util.stream.Stream;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.inject.Inject; import javax.inject.Inject;
import lombok.AccessLevel; import lombok.AccessLevel;
import lombok.Getter; import lombok.Getter;
import net.runelite.api.ChatMessageType; import net.runelite.api.*;
import net.runelite.api.Client; import net.runelite.api.events.*;
import net.runelite.api.DecorativeObject; import net.runelite.api.widgets.Widget;
import net.runelite.api.EquipmentInventorySlot; import net.runelite.api.widgets.WidgetInfo;
import net.runelite.api.GameState;
import net.runelite.api.InventoryID;
import net.runelite.api.Item;
import net.runelite.api.ItemContainer;
import net.runelite.api.ItemID;
import net.runelite.api.MenuEntry;
import net.runelite.api.NPC;
import net.runelite.api.NpcID;
import net.runelite.api.events.ChatMessage;
import net.runelite.api.events.ConfigChanged;
import net.runelite.api.events.DecorativeObjectDespawned;
import net.runelite.api.events.DecorativeObjectSpawned;
import net.runelite.api.events.GameStateChanged;
import net.runelite.api.events.ItemContainerChanged;
import net.runelite.api.events.MenuEntryAdded;
import net.runelite.api.events.NpcDespawned;
import net.runelite.api.events.NpcSpawned;
import net.runelite.client.Notifier; import net.runelite.client.Notifier;
import net.runelite.client.config.ConfigManager; import net.runelite.client.config.ConfigManager;
import net.runelite.client.eventbus.Subscribe; import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.plugins.Plugin; import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor; import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.ui.overlay.OverlayManager; import net.runelite.client.ui.overlay.OverlayManager;
import static net.runelite.client.util.MenuUtil.swap;
import net.runelite.client.util.Text; import net.runelite.client.util.Text;
import static net.runelite.client.util.MenuUtil.swap;
@PluginDescriptor( @PluginDescriptor(
name = "Runecraft", name = "Runecraft",
description = "Show minimap icons and clickboxes for abyssal rifts", description = "Show minimap icons and clickboxes for abyssal rifts",
tags = {"abyssal", "minimap", "overlay", "rifts", "rc", "runecrafting"} tags = {"abyssal", "minimap", "overlay", "rifts", "rc", "runecrafting"}
) )
public class RunecraftPlugin extends Plugin public class RunecraftPlugin extends Plugin {
{ private static final int[] CASTLE_WARS = {9776};
private static final int[] FIRE_ALTAR = {10315};
private static final String POUCH_DECAYED_NOTIFICATION_MESSAGE = "Your rune pouch has decayed."; private static final String POUCH_DECAYED_NOTIFICATION_MESSAGE = "Your rune pouch has decayed.";
private static final String POUCH_DECAYED_MESSAGE = "Your pouch has decayed through use."; private static final String POUCH_DECAYED_MESSAGE = "Your pouch has decayed through use.";
private static final List<Integer> DEGRADED_POUCHES = ImmutableList.of( private static final List<Integer> DEGRADED_POUCHES = ImmutableList.of(
ItemID.MEDIUM_POUCH_5511, ItemID.MEDIUM_POUCH_5511,
ItemID.LARGE_POUCH_5513, ItemID.LARGE_POUCH_5513,
ItemID.GIANT_POUCH_5515 ItemID.GIANT_POUCH_5515
); );
private static final List<Integer> POUCHES = ImmutableList.of( private static final List<Integer> POUCHES = ImmutableList.of(
ItemID.SMALL_POUCH, ItemID.SMALL_POUCH,
ItemID.MEDIUM_POUCH, ItemID.MEDIUM_POUCH,
ItemID.LARGE_POUCH, ItemID.LARGE_POUCH,
ItemID.GIANT_POUCH ItemID.GIANT_POUCH
); );
private boolean wearingTiara; private boolean wearingTiara;
private boolean wearingCape;
@Getter(AccessLevel.PACKAGE) @Getter(AccessLevel.PACKAGE)
private final Set<DecorativeObject> abyssObjects = new HashSet<>(); private final Set<DecorativeObject> abyssObjects = new HashSet<>();
@@ -103,6 +97,9 @@ public class RunecraftPlugin extends Plugin
@Inject @Inject
private AbyssOverlay abyssOverlay; private AbyssOverlay abyssOverlay;
@Inject
private RunecraftOverlay runecraftOverlay;
@Inject @Inject
private RunecraftConfig config; private RunecraftConfig config;
@@ -110,114 +107,108 @@ public class RunecraftPlugin extends Plugin
private Notifier notifier; private Notifier notifier;
@Provides @Provides
RunecraftConfig getConfig(ConfigManager configManager) RunecraftConfig getConfig(ConfigManager configManager) {
{
return configManager.getConfig(RunecraftConfig.class); return configManager.getConfig(RunecraftConfig.class);
} }
@Override @Override
protected void startUp() throws Exception protected void startUp() throws Exception {
{
overlayManager.add(abyssOverlay); overlayManager.add(abyssOverlay);
abyssOverlay.updateConfig(); abyssOverlay.updateConfig();
overlayManager.add(runecraftOverlay);
} }
@Override @Override
protected void shutDown() throws Exception protected void shutDown() throws Exception {
{
overlayManager.remove(abyssOverlay); overlayManager.remove(abyssOverlay);
abyssObjects.clear(); abyssObjects.clear();
darkMage = null; darkMage = null;
degradedPouchInInventory = false; degradedPouchInInventory = false;
overlayManager.remove(runecraftOverlay);
} }
@Subscribe @Subscribe
public void onConfigChanged(ConfigChanged event) public void onConfigChanged(ConfigChanged event) {
{
abyssOverlay.updateConfig(); abyssOverlay.updateConfig();
} }
@Subscribe @Subscribe
public void onChatMessage(ChatMessage event) public void onChatMessage(ChatMessage event) {
{ if (event.getType() != ChatMessageType.GAMEMESSAGE) {
if (event.getType() != ChatMessageType.GAMEMESSAGE)
{
return; return;
} }
if (config.degradingNotification()) if (config.degradingNotification()) {
{ if (event.getMessage().contains(POUCH_DECAYED_MESSAGE)) {
if (event.getMessage().contains(POUCH_DECAYED_MESSAGE))
{
notifier.notify(POUCH_DECAYED_NOTIFICATION_MESSAGE); notifier.notify(POUCH_DECAYED_NOTIFICATION_MESSAGE);
} }
} }
} }
@Subscribe @Subscribe
public void onMenuEntryAdded(MenuEntryAdded entry) public void onMenuEntryAdded(MenuEntryAdded entry) {
{ if (client.getGameState() != GameState.LOGGED_IN) {
if (!wearingTiara) return;
{ }
Widget loginScreenOne = client.getWidget(WidgetInfo.LOGIN_CLICK_TO_PLAY_SCREEN);
Widget loginScreenTwo = client.getWidget(WidgetInfo.LOGIN_CLICK_TO_PLAY_SCREEN_MESSAGE_OF_THE_DAY);
if (loginScreenOne != null || loginScreenTwo != null) {
return; return;
} }
final String option = Text.removeTags(entry.getOption()).toLowerCase(); final String option = Text.removeTags(entry.getOption()).toLowerCase();
final String target = Text.removeTags(entry.getTarget()).toLowerCase(); final String target = Text.removeTags(entry.getTarget()).toLowerCase();
final int id = entry.getIdentifier();
final int type = entry.getType();
if (target.contains("pouch") && !target.startsWith("rune"))
{ Widget widgetBankTitleBar = client.getWidget(WidgetInfo.BANK_TITLE_BAR);
if (option.equals("deposit-all") && type == 57 && id == 2) if (isEssencePouch(target)) {
{ if (widgetBankTitleBar == null || widgetBankTitleBar.isHidden()) { //swap pouches based on empty/full and in bank
swap(client, "fill", option, target); swap(client, "Empty", option, target);
swap(client, "cancel", option, "", target); } else {
} swap(client, "Fill", option, target); //Due to RuneLite issues the "Deposit" menutext will always show even though it is on fill
else if (option.equals("fill") && id != 9)
{
swap(client, "empty", option, target);
} }
} else if (target.contains("ring of dueling") && option.contains("withdraw")) { //withdraw-1 ring of dueling
swap(client, "withdraw-1", option, target);
} else if (target.contains("binding necklace") && option.contains("withdraw")) { //withdraw-1 binding necklace
swap(client, "withdraw-1", option, target);
} }
else if (target.contains("ring of dueling") && option.contains("remove")) {
else if (target.contains("ring of dueling") && option.contains("remove")) if (client.getLocalPlayer().getWorldLocation().getRegionID() != 10315) { //changes duel ring teleport options based on location
{ swap(client, "duel arena", option, target);
if (target.contains("7") || target.contains("5") || target.contains("3") || target.contains("1")) } else if (client.getLocalPlayer().getWorldLocation().getRegionID() == 10315) {
{
swap(client, "castle wars", option, target); swap(client, "castle wars", option, target);
} }
else if (wearingBindingNeck()) }
{ else if(target.contains("crafting cape") && option.contains("remove")) { //teleport for crafting cape
swap(client, "duel arena", option, target); swap(client, "Teleport", option, target);
} else if(target.contains("max cape") && option.contains("remove")) { //teleport for max cape
swap(client, "Crafting Guild", option, target);
} }
else if (target.contains("altar") && option.contains("craft")) // Don't accidentally click the altar to craft
{
hide(option, target, true);
} else if (target.contains("pure")) // Don't accidentally use pure essence on altar
{
hide("use", target, true);
hide("drop", target, true);
} }
else if (target.contains("altar") && option.contains("craft")) // Don't accidentally click the altar to craft
{
hide(option, target, true);
}
else if (target.contains("pure") && option.contains("use")) // Don't accidentally use pure essence on altar
{
hide(option, target, true);
}
} }
private void hide(String option, String target, boolean contains) private void hide(String option, String target, boolean contains) {
{
final MenuEntry[] entries = client.getMenuEntries(); final MenuEntry[] entries = client.getMenuEntries();
int index = searchIndex(entries, option, target, contains); int index = searchIndex(entries, option, target, contains);
if (index < 0) if (index < 0) {
{
return; return;
} }
MenuEntry[] newEntries = new MenuEntry[entries.length - 1]; MenuEntry[] newEntries = new MenuEntry[entries.length - 1];
int i2 = 0; int i2 = 0;
for (int i = 0; i < entries.length - 1; i++) for (int i = 0; i < entries.length - 1; i++) {
{ if (i == index) {
if (i == index)
{
continue; continue;
} }
@@ -228,21 +219,14 @@ public class RunecraftPlugin extends Plugin
client.setMenuEntries(newEntries); client.setMenuEntries(newEntries);
} }
private int searchIndex(MenuEntry[] entries, String option, String target) private int searchIndex(MenuEntry[] entries, String option, String target, boolean contains) {
{ for (int i = entries.length - 1; i >= 0; i--) {
return searchIndex(entries, option, target, false);
}
private int searchIndex(MenuEntry[] entries, String option, String target, boolean contains)
{
for (int i = entries.length - 1; i >= 0; i--)
{
MenuEntry entry = entries[i]; MenuEntry entry = entries[i];
String entryOption = Text.removeTags(entry.getOption()).toLowerCase(); String entryOption = Text.removeTags(entry.getOption()).toLowerCase();
String entryTarget = Text.removeTags(entry.getTarget()).toLowerCase(); String entryTarget = Text.removeTags(entry.getTarget()).toLowerCase();
if (entryOption.contains(option.toLowerCase()) if (entryOption.contains(option.toLowerCase())
&& (entryTarget.equals(target) || (entryTarget.contains(target) && contains))) && (entryTarget.equals(target) || (entryTarget.contains(target) && contains))) {
{
return i; return i;
} }
} }
@@ -250,29 +234,29 @@ public class RunecraftPlugin extends Plugin
return -1; return -1;
} }
private boolean isEssencePouch(String target) {
return (target.equalsIgnoreCase("Small Pouch") || target.equalsIgnoreCase("Medium Pouch") || target.equalsIgnoreCase("Large Pouch") || target.equalsIgnoreCase("Giant Pouch"));
}
@Subscribe @Subscribe
public void onDecorativeObjectSpawned(DecorativeObjectSpawned event) public void onDecorativeObjectSpawned(DecorativeObjectSpawned event) {
{
DecorativeObject decorativeObject = event.getDecorativeObject(); DecorativeObject decorativeObject = event.getDecorativeObject();
if (AbyssRifts.getRift(decorativeObject.getId()) != null) if (AbyssRifts.getRift(decorativeObject.getId()) != null) {
{
abyssObjects.add(decorativeObject); abyssObjects.add(decorativeObject);
} }
} }
@Subscribe @Subscribe
public void onDecorativeObjectDespawned(DecorativeObjectDespawned event) public void onDecorativeObjectDespawned(DecorativeObjectDespawned event) {
{
DecorativeObject decorativeObject = event.getDecorativeObject(); DecorativeObject decorativeObject = event.getDecorativeObject();
abyssObjects.remove(decorativeObject); abyssObjects.remove(decorativeObject);
} }
@Subscribe @Subscribe
public void onGameStateChanged(GameStateChanged event) public void onGameStateChanged(GameStateChanged event) {
{
GameState gameState = event.getGameState(); GameState gameState = event.getGameState();
switch (gameState) switch (gameState) {
{
case LOADING: case LOADING:
abyssObjects.clear(); abyssObjects.clear();
break; break;
@@ -285,48 +269,33 @@ public class RunecraftPlugin extends Plugin
} }
@Subscribe @Subscribe
public void onItemContainerChanged(ItemContainerChanged event) public void onItemContainerChanged(ItemContainerChanged event) {
{ if (event.getItemContainer() == client.getItemContainer(InventoryID.INVENTORY)) {
if (event.getItemContainer() == client.getItemContainer(InventoryID.INVENTORY))
{
final Item[] items = event.getItemContainer().getItems();
degradedPouchInInventory = Stream.of(items).anyMatch(i -> DEGRADED_POUCHES.contains(i.getId()));
}
else if (event.getItemContainer() == client.getItemContainer(InventoryID.EQUIPMENT))
{
final Item[] items = event.getItemContainer().getItems(); final Item[] items = event.getItemContainer().getItems();
wearingTiara = config.opLavas() && items[EquipmentInventorySlot.HEAD.getSlotIdx()].getId() == ItemID.FIRE_TIARA; degradedPouchInInventory = Stream.of(items).anyMatch(i -> DEGRADED_POUCHES.contains(i.getId()));
} else if (event.getItemContainer() == client.getItemContainer(InventoryID.EQUIPMENT)) {
final Item[] items = event.getItemContainer().getItems();
wearingTiara = config.Lavas() && items[EquipmentInventorySlot.HEAD.getSlotIdx()].getId() == ItemID.FIRE_TIARA;
wearingCape = config.Lavas() && items[EquipmentInventorySlot.CAPE.getSlotIdx()].getId() == ItemID.RUNECRAFT_CAPE || items[EquipmentInventorySlot.CAPE.getSlotIdx()].getId() == ItemID.RUNECRAFT_CAPET;
System.out.println("item changed");
} }
} }
@Subscribe @Subscribe
public void onNpcSpawned(NpcSpawned event) public void onNpcSpawned(NpcSpawned event) {
{
final NPC npc = event.getNpc(); final NPC npc = event.getNpc();
if (npc.getId() == NpcID.DARK_MAGE) if (npc.getId() == NpcID.DARK_MAGE) {
{
darkMage = npc; darkMage = npc;
} }
} }
@Subscribe @Subscribe
public void onNpcDespawned(NpcDespawned event) public void onNpcDespawned(NpcDespawned event) {
{
final NPC npc = event.getNpc(); final NPC npc = event.getNpc();
if (npc == darkMage) if (npc == darkMage) {
{
darkMage = null; darkMage = null;
} }
} }
private boolean wearingBindingNeck()
{
final ItemContainer worn = client.getItemContainer(InventoryID.EQUIPMENT);
if (worn == null)
{
return false;
}
return worn.getItems()[EquipmentInventorySlot.AMULET.getSlotIdx()].getId() == ItemID.BINDING_NECKLACE;
}
} }