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

Magic Spellbook

Browse Source
This commit is contained in:
Lucas
2019-04-30 21:48:29 +02:00
parent 7a84166d79
commit 6e8a29452c
11 changed files with 1441 additions and 669 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
runelite-api/src/main/java/net/runelite/api/EnumID.java
View File

@@ -33,4 +33,17 @@ public final class EnumID
{
public static final int MUSIC_TRACK_NAMES = 812;
public static final int MUSIC_TRACK_IDS = 819;
/**
* Translates spellbook varbit into enum ID
*/
public static final int SPELLBOOKS = 1981;
/**
* key: index in spellbook, value: NullItemID corresponding to spell
*/
public static final int STANDARD_SPELLBOOK = 1982;
public static final int ANCIENT_SPELLBOOK = 1983;
public static final int LUNAR_SPELLBOOK = 1984;
public static final int ARCEUUS_SPELLBOOK = 1985;
}

1238
runelite-api/src/main/java/net/runelite/api/Varbits.java
View File

File diff suppressed because it is too large Load Diff

21
runelite-api/src/main/java/net/runelite/api/widgets/WidgetID.java
View File

@@ -432,7 +432,7 @@ public class WidgetID
static final int EQUIP_ICON = 61;
static final int PRAYER_TAB = 55;
static final int PRAYER_ICON = 62;
static final int SPELL_TAB = 56;
static final int MAGIC_TAB = 56;
static final int SPELL_ICON = 53;
static final int FC_TAB = 35;
static final int FC_ICON = 41;
@@ -763,10 +763,13 @@ public class WidgetID
static final int TELEPORT_BUTTON = 26;
}
static class StandardSpellBook
static class SpellBook
{
static final int FILTERED_SPELLS_BOUNDS = 3;
// NORMAL SPELLS
static final int LUMBRIDGE_HOME_TELEPORT = 4;
static final int WIND_STRIKE = 5;
static final int WIND_STRIKE = 5;
static final int CONFUSE = 6;
static final int ENCHANT_CROSSBOW_BOLT = 7;
static final int WATER_STRIKE = 8;
@@ -835,10 +838,8 @@ static final int WIND_STRIKE = 5;
static final int EARTH_SURGE = 71;
static final int LVL_7_ENCHANT = 72;
static final int FIRE_SURGE = 73;
}
static class AncientSpellBook {
static final int BOUNTY_TARGET_TELEPORT = 68;
// ANCIENT SPELLS
static final int ICE_RUSH = 74;
static final int ICE_BLITZ = 75;
static final int ICE_BURST = 76;
@@ -864,10 +865,8 @@ static final int WIND_STRIKE = 5;
static final int ANNAKARL_TELEPORT = 96;
static final int GHORROCK_TELEPORT = 97;
static final int EDGEVILLE_HOME_TELEPORT = 98;
}
static class LunarSpellBook {
static final int BOUNTY_TARGET_TELEPORT = 68;
// LUNAR SPELLS
static final int LUNAR_HOME_TELEPORT = 99;
static final int BAKE_PIE = 100;
static final int CURE_PLANT = 101;
@@ -912,10 +911,8 @@ static final int WIND_STRIKE = 5;
static final int GEOMANCY = 140;
static final int SPIN_FLAX = 141;
static final int OURANIA_TELEPORT = 142;
}
static class ArceuusSpellBook
{
// ARCEUUS SPELLS
static final int ARCEUUS_HOME_TELEPORT = 143;
}

78
runelite-api/src/main/java/net/runelite/api/widgets/WidgetInfo.java
View File

@@ -263,6 +263,7 @@ public enum WidgetInfo
RESIZABLE_VIEWPORT_BOTTOM_LINE_EQUIPMENT_ICON(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewportBottomLine.EQUIP_ICON),
RESIZABLE_VIEWPORT_BOTTOM_LINE_COMBAT_ICON(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewportBottomLine.CMB_ICON),
RESIZABLE_VIEWPORT_BOTTOM_LINE_STATS_ICON(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewportBottomLine.SKILLS_ICON),
RESIZABLE_VIEWPORT_BOTTOM_LINE_MAGIC_TAB(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewportBottomLine.MAGIC_TAB),
RESIZABLE_VIEWPORT_BOTTOM_LINE_MAGIC_ICON(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewportBottomLine.MAGIC_ICON),
RESIZABLE_VIEWPORT_BOTTOM_LINE_FRIEND_ICON(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewportBottomLine.FRIEND_ICON),
RESIZABLE_VIEWPORT_BOTTOM_LINE_FRIEND_CHAT_ICON(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewportBottomLine.FC_ICON),
@@ -485,54 +486,55 @@ public enum WidgetInfo
PVP_BOUNTY_HUNTER_INFO(WidgetID.PVP_GROUP_ID, WidgetID.Pvp.BOUNTY_HUNTER_INFO),
PVP_KILLDEATH_COUNTER(WidgetID.PVP_GROUP_ID, WidgetID.Pvp.KILLDEATH_RATIO),
SPELLBOOK_FILTERED_BOUNDS(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.FILTERED_SPELLS_BOUNDS),
/* STANDARD SPELL BOOK WIDGETS*/
SPELL_LUMBRIDGE_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.StandardSpellBook.LUMBRIDGE_HOME_TELEPORT),
SPELL_BIND(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.StandardSpellBook.BIND),
SPELL_SNARE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.StandardSpellBook.SNARE),
SPELL_ENTANGLE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.StandardSpellBook.ENTANGLE),
SPELL_TELE_BLOCK(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.StandardSpellBook.TELE_BLOCK),
SPELL_FIRE_SURGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.StandardSpellBook.FIRE_SURGE),
SPELL_BOUNTY_TARGET_TELEPORT2(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.StandardSpellBook.BOUNTY_TARGET_TELEPORT),
SPELL_LUMBRIDGE_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.LUMBRIDGE_HOME_TELEPORT),
SPELL_BIND(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BIND),
SPELL_SNARE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SNARE),
SPELL_ENTANGLE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.ENTANGLE),
SPELL_TELE_BLOCK(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.TELE_BLOCK),
SPELL_FIRE_SURGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.FIRE_SURGE),
SPELL_BOUNTY_TARGET_TELEPORT2(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BOUNTY_TARGET_TELEPORT),
/* END OF STANDARD SPELL BOOK WIDGETS*/
/* LUNAR SPELL BOOK WIDGETS*/
SPELL_LUNAR_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.LunarSpellBook.LUNAR_HOME_TELEPORT),
SPELL_VENGEANCE_OTHER(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.LunarSpellBook.VENGEANCE_OTHER),
SPELL_VENGEANCE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.LunarSpellBook.VENGEANCE),
SPELL_BOUNTY_TARGET_TELEPORT3(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.LunarSpellBook.BOUNTY_TARGET_TELEPORT),
SPELL_LUNAR_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.LUNAR_HOME_TELEPORT),
SPELL_VENGEANCE_OTHER(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.VENGEANCE_OTHER),
SPELL_VENGEANCE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.VENGEANCE),
SPELL_BOUNTY_TARGET_TELEPORT3(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BOUNTY_TARGET_TELEPORT),
/* LUNA SPELL BOOK WIDGETS*/
/* ARCEUUS SPELL BOOK WIDGETS*/
SPELL_ARCEUUS_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.ArceuusSpellBook.ARCEUUS_HOME_TELEPORT),
SPELL_ARCEUUS_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.ARCEUUS_HOME_TELEPORT),
/* END OF ARCEUUS SPELL BOOK WIDGETS*/
/* ANCIENT SPELL BOOK WIDGETS*/
SPELL_ICE_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.ICE_RUSH),
SPELL_ICE_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.ICE_BLITZ),
SPELL_ICE_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.ICE_BURST),
SPELL_ICE_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.ICE_BARRAGE),
SPELL_BLOOD_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.BLOOD_RUSH),
SPELL_BLOOD_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.BLOOD_BLITZ),
SPELL_BLOOD_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.BLOOD_BURST),
SPELL_BLOOD_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.BLOOD_BARRAGE),
SPELL_SMOKE_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SMOKE_RUSH),
SPELL_SMOKE_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SMOKE_BLITZ),
SPELL_SMOKE_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SMOKE_BURST),
SPELL_SMOKE_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SMOKE_BARRAGE),
SPELL_SHADOW_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SHADOW_RUSH),
SPELL_SHADOW_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SHADOW_BLITZ),
SPELL_SHADOW_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SHADOW_BURST),
SPELL_SHADOW_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SHADOW_BARRAGE),
SPELL_PADDEWWA_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.PADDEWWA_TELEPORT),
SPELL_SENNTISTEN_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.SENNTISTEN_TELEPORT),
SPELL_KHARYRLL_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.KHARYRLL_TELEPORT),
SPELL_LASSAR_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.LASSAR_TELEPORT),
SPELL_DAREEYAK_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.DAREEYAK_TELEPORT),
SPELL_CARRALLANGER_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.CARRALLANGER_TELEPORT),
SPELL_ANNAKARL_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.ANNAKARL_TELEPORT),
SPELL_GHORROCK_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.GHORROCK_TELEPORT),
SPELL_EDGEVILLE_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.EDGEVILLE_HOME_TELEPORT),
SPELL_BOUNTY_TARGET_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.AncientSpellBook.BOUNTY_TARGET_TELEPORT),
SPELL_ICE_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.ICE_RUSH),
SPELL_ICE_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.ICE_BLITZ),
SPELL_ICE_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.ICE_BURST),
SPELL_ICE_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.ICE_BARRAGE),
SPELL_BLOOD_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BLOOD_RUSH),
SPELL_BLOOD_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BLOOD_BLITZ),
SPELL_BLOOD_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BLOOD_BURST),
SPELL_BLOOD_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BLOOD_BARRAGE),
SPELL_SMOKE_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SMOKE_RUSH),
SPELL_SMOKE_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SMOKE_BLITZ),
SPELL_SMOKE_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SMOKE_BURST),
SPELL_SMOKE_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SMOKE_BARRAGE),
SPELL_SHADOW_RUSH(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SHADOW_RUSH),
SPELL_SHADOW_BLITZ(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SHADOW_BLITZ),
SPELL_SHADOW_BURST(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SHADOW_BURST),
SPELL_SHADOW_BARRAGE(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SHADOW_BARRAGE),
SPELL_PADDEWWA_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.PADDEWWA_TELEPORT),
SPELL_SENNTISTEN_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.SENNTISTEN_TELEPORT),
SPELL_KHARYRLL_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.KHARYRLL_TELEPORT),
SPELL_LASSAR_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.LASSAR_TELEPORT),
SPELL_DAREEYAK_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.DAREEYAK_TELEPORT),
SPELL_CARRALLANGER_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.CARRALLANGER_TELEPORT),
SPELL_ANNAKARL_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.ANNAKARL_TELEPORT),
SPELL_GHORROCK_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.GHORROCK_TELEPORT),
SPELL_EDGEVILLE_HOME_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.EDGEVILLE_HOME_TELEPORT),
SPELL_BOUNTY_TARGET_TELEPORT(WidgetID.SPELLBOOK_GROUP_ID, WidgetID.SpellBook.BOUNTY_TARGET_TELEPORT),
/* END OF ANCIENT SPELL BOOK WIDGETS*/

14
runelite-client/src/main/java/net/runelite/client/plugins/spellbook/Spell.java Normal file
View File

@@ -0,0 +1,14 @@
package net.runelite.client.plugins.spellbook;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Data
@EqualsAndHashCode
class Spell
{
private int widget;
private int x;
private int y;
private String name;
}

36
runelite-client/src/main/java/net/runelite/client/plugins/spellbook/Spellbook.java Normal file
View File

@@ -0,0 +1,36 @@
package net.runelite.client.plugins.spellbook;
import java.util.HashMap;
import java.util.Map;
import lombok.AllArgsConstructor;
import lombok.Getter;
@AllArgsConstructor
public enum Spellbook
{
STANDARD(0, "standard"),
ANCIENT(1, "ancient"),
LUNAR(2, "lunar"),
ARCEUUS(3, "arceuus");
@Getter
private final int id;
@Getter
private final String configKey;
private static final Map<Integer, Spellbook> map = new HashMap<>();
static
{
for (Spellbook s : values())
{
map.put(s.id, s);
}
}
public static Spellbook getByID(int id)
{
return map.get(id);
}
}

116
runelite-client/src/main/java/net/runelite/client/plugins/spellbook/SpellbookConfig.java Normal file
View File

@@ -0,0 +1,116 @@
package net.runelite.client.plugins.spellbook;
import net.runelite.client.config.Config;
import net.runelite.client.config.ConfigGroup;
import net.runelite.client.config.ConfigItem;
@ConfigGroup("spellbook")
public interface SpellbookConfig extends Config
{
@ConfigItem(
keyName = "enableMobile",
name = "Mobile spellbook",
description = "Show the mobile spellbook with filtered spells enabled",
position = 1
)
default boolean enableMobile()
{
return true;
}
@ConfigItem(
keyName = "dragSpells",
name = "Change spell location",
description = "Add menu entry to spellbook which toggles moving spells by dragging. Only works with spells filtered",
position = 2
)
default boolean dragSpells()
{
return true;
}
@ConfigItem(
keyName = "size",
name = "Spell size",
description = "Size (in px) of spells. Normal mobile size is 40px, use common sense for this setting please",
position = 3
)
default int size()
{
return 40;
}
@ConfigItem(
keyName = "filter",
name = "Unfiltered spells",
description = "Spells you don't want to filter, seperated with a comma"
)
default String filter()
{
return "";
}
@ConfigItem(
keyName = "standard",
name = "",
description = "",
hidden = true
)
default String standard()
{
return "";
}
@ConfigItem(
keyName = "ancient",
name = "",
description = "",
hidden = true
)
default String ancient()
{
return "";
}
@ConfigItem(
keyName = "lunar",
name = "",
description = "",
hidden = true
)
default String lunar()
{
return "";
}
@ConfigItem(
keyName = "arceuus",
name = "",
description = "",
hidden = true
)
default String arceuus()
{
return "";
}
@ConfigItem(
keyName = "canDrag",
name = "",
description = "",
hidden = true
)
default boolean canDrag()
{
return false;
}
@ConfigItem(
keyName = "canDrag",
name = "",
description = "",
hidden = true
)
void canDrag(boolean canDrag);
}

57
runelite-client/src/main/java/net/runelite/client/plugins/spellbook/SpellbookDragOverlay.java Normal file
View File

@@ -0,0 +1,57 @@
package net.runelite.client.plugins.spellbook;
import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.image.BufferedImage;
import javax.inject.Inject;
import javax.inject.Singleton;
import net.runelite.api.Client;
import net.runelite.client.game.SpriteManager;
import net.runelite.client.ui.overlay.Overlay;
import net.runelite.client.ui.overlay.OverlayLayer;
import net.runelite.client.ui.overlay.OverlayPosition;
import net.runelite.client.ui.overlay.OverlayPriority;
@Singleton
public class SpellbookDragOverlay extends Overlay
{
private SpellbookPlugin plugin;
private Client client;
private SpriteManager spriteManager;
@Inject
private SpellbookDragOverlay(SpellbookPlugin plugin, Client client, SpriteManager spriteManager)
{
this.plugin = plugin;
this.client = client;
this.spriteManager = spriteManager;
setPosition(OverlayPosition.TOOLTIP);
setPriority(OverlayPriority.HIGHEST);
setLayer(OverlayLayer.ALWAYS_ON_TOP);
}
@Override
public Dimension render(Graphics2D g)
{
if (!plugin.isDragging())
{
return null;
}
final net.runelite.api.Point mouseCanvasPosition = client.getMouseCanvasPosition();
final net.runelite.api.Point draggingLocation = plugin.getDraggingLocation();
final int size = plugin.getDraggingWidget().getWidth();
final int sprite = plugin.getDraggingWidget().getSpriteId();
final BufferedImage image = spriteManager.getSprite(sprite, 0);
final Point mousePosition = new Point(mouseCanvasPosition.getX() - draggingLocation.getX(), mouseCanvasPosition.getY() - draggingLocation.getY());
final Rectangle bounds = new Rectangle(mousePosition.x, mousePosition.y, size, size);
g.drawImage(image, mousePosition.x, mousePosition.y, size, size, null);
return bounds.getSize();
}
}

55
runelite-client/src/main/java/net/runelite/client/plugins/spellbook/SpellbookMouseListener.java Normal file
View File

@@ -0,0 +1,55 @@
package net.runelite.client.plugins.spellbook;
import java.awt.event.MouseEvent;
import javax.swing.SwingUtilities;
import net.runelite.client.input.MouseAdapter;
public class SpellbookMouseListener extends MouseAdapter
{
private final SpellbookPlugin plugin;
SpellbookMouseListener(SpellbookPlugin plugin)
{
this.plugin = plugin;
}
@Override
public MouseEvent mouseClicked(MouseEvent event)
{
if (SwingUtilities.isMiddleMouseButton(event) || !plugin.isOnSpellWidget(event.getPoint()))
{
return event;
}
event.consume();
return event;
}
@Override
public MouseEvent mousePressed(MouseEvent event)
{
if (!SwingUtilities.isLeftMouseButton(event) || !plugin.isOnSpellWidget(event.getPoint()) || plugin.isDragging())
{
return event;
}
plugin.startDragging(event.getPoint());
event.consume();
return event;
}
@Override
public MouseEvent mouseReleased(MouseEvent event)
{
if (!SwingUtilities.isLeftMouseButton(event) || !plugin.isDragging())
{
return event;
}
plugin.completeDragging(event.getPoint());
event.consume();
return event;
}
}

449
runelite-client/src/main/java/net/runelite/client/plugins/spellbook/SpellbookPlugin.java Normal file
View File

@@ -0,0 +1,449 @@
package net.runelite.client.plugins.spellbook;
import com.google.common.base.Strings;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import com.google.inject.Provides;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import javax.inject.Inject;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.GameState;
import net.runelite.api.Point;
import net.runelite.api.Varbits;
import net.runelite.api.events.ConfigChanged;
import net.runelite.api.events.GameStateChanged;
import net.runelite.api.events.ScriptCallbackEvent;
import net.runelite.api.events.VarbitChanged;
import net.runelite.api.events.WidgetMenuOptionClicked;
import net.runelite.api.widgets.Widget;
import net.runelite.api.widgets.WidgetInfo;
import net.runelite.client.callback.ClientThread;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.input.MouseManager;
import net.runelite.client.menus.MenuManager;
import net.runelite.client.menus.WidgetMenuOption;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.ui.overlay.OverlayManager;
import net.runelite.client.util.Text;
@PluginDescriptor(
name = "Spellbook",
description = "Modifications to the spellbook",
tags = {"resize", "spell", "mobile", "lowers", "pvp", "skill", "level"}
)
@Slf4j
public class SpellbookPlugin extends Plugin
{
private static final int FULL_WIDTH = 184;
private static final int FULL_HEIGHT = 240;
private static final Gson GSON = new Gson();
private static final String LOCK = "Disable";
private static final String UNLOCK = "Enable";
private static final String MENU_TARGET = "Reordering";
private static final WidgetMenuOption FIXED_MAGIC_TAB_LOCK = new WidgetMenuOption(LOCK, MENU_TARGET, WidgetInfo.FIXED_VIEWPORT_MAGIC_TAB);
private static final WidgetMenuOption FIXED_MAGIC_TAB_UNLOCK = new WidgetMenuOption(UNLOCK, MENU_TARGET, WidgetInfo.FIXED_VIEWPORT_MAGIC_TAB);
private static final WidgetMenuOption RESIZABLE_MAGIC_TAB_LOCK = new WidgetMenuOption(LOCK, MENU_TARGET, WidgetInfo.RESIZABLE_VIEWPORT_MAGIC_TAB);
private static final WidgetMenuOption RESIZABLE_MAGIC_TAB_UNLOCK = new WidgetMenuOption(UNLOCK, MENU_TARGET, WidgetInfo.RESIZABLE_VIEWPORT_MAGIC_TAB);
private static final WidgetMenuOption RESIZABLE_BOTTOM_LINE_MAGIC_TAB_LOCK = new WidgetMenuOption(LOCK, MENU_TARGET, WidgetInfo.RESIZABLE_VIEWPORT_BOTTOM_LINE_MAGIC_TAB);
private static final WidgetMenuOption RESIZABLE_BOTTOM_LINE_MAGIC_TAB_UNLOCK = new WidgetMenuOption(UNLOCK, MENU_TARGET, WidgetInfo.RESIZABLE_VIEWPORT_BOTTOM_LINE_MAGIC_TAB);
@Inject
private Client client;
@Inject
private ClientThread clientThread;
@Inject
private ConfigManager configManager;
@Inject
private SpellbookConfig config;
@Inject
private MenuManager menuManager;
@Inject
private MouseManager mouseManager;
@Inject
private OverlayManager overlayManager;
@Inject
private SpellbookDragOverlay overlay;
@Getter
private boolean dragging;
@Getter
private Widget draggingWidget;
@Getter
private Point draggingLocation;
private Map<Integer, Spell> spells = new HashMap<>();
private List<String> notFilteredSpells = new ArrayList<>();
private Spellbook spellbook;
private SpellbookMouseListener mouseListener;
@Provides
SpellbookConfig getConfig(ConfigManager configManager)
{
return configManager.getConfig(SpellbookConfig.class);
}
@Override
protected void startUp()
{
refreshMagicTabOption();
loadFilter();
mouseListener = new SpellbookMouseListener(this);
}
@Override
protected void shutDown()
{
clearMagicTabMenus();
saveSpells();
config.canDrag(false);
mouseListener = null;
}
@Subscribe
public void onGameStateChanged(GameStateChanged event)
{
if (event.getGameState() == GameState.LOGGED_IN)
{
refreshMagicTabOption();
}
}
@Subscribe
public void onConfigChanged(ConfigChanged event)
{
if (!"spellbook".equals(event.getGroup()))
{
return;
}
String key = event.getKey();
if ("canDrag".equals(key))
{
refreshMagicTabOption();
}
else if ("filter".equals(key))
{
loadFilter();
}
runRebuild();
}
@Subscribe
public void onVarbitChanged(VarbitChanged event)
{
if (client.getGameState() != GameState.LOGGED_IN)
{
return;
}
if (config.canDrag())
{
config.canDrag(client.getVar(Varbits.FILTER_SPELLBOOK) == 1);
}
}
@Subscribe
public void onScriptCallbackEvent(ScriptCallbackEvent event)
{
if (client.getVar(Varbits.FILTER_SPELLBOOK) != 0 || !config.enableMobile() || !event.getEventName().toLowerCase().contains("spell"))
{
return;
}
int[] iStack = client.getIntStack();
int iStackSize = client.getIntStackSize();
String[] sStack = client.getStringStack();
int sStackSize = client.getStringStackSize();
if ("shouldFilterSpell".equals(event.getEventName()))
{
String spell = sStack[sStackSize - 1].toLowerCase();
int widget = iStack[iStackSize - 1];
spellbook = Spellbook.getByID(client.getVar(Varbits.SPELLBOOK));
loadSpells();
// Add the spell to spells
if (!spells.containsKey(widget))
{
Spell s = new Spell();
s.setWidget(widget);
s.setX(-1);
s.setY(-1);
s.setName(spell);
spells.put(widget, s);
}
if (notFilteredSpells.isEmpty())
{
return;
}
iStack[iStackSize - 2] = notFilteredSpells.stream().anyMatch(spell::contains) ? 1 : 0;
}
else if ("isMobileSpellbookEnabled".equals(event.getEventName()))
{
iStack[iStackSize - 1] = 1;
}
else if ("resizeSpell".equals(event.getEventName()))
{
int size = config.size();
int columns = Math.max(2, Math.min(FULL_WIDTH / size, 3));
iStack[iStackSize - 1] = columns;
iStack[iStackSize - 2] = size;
}
else if ("setSpellAreaSize".equals(event.getEventName()))
{
if (!config.dragSpells())
{
return;
}
iStack[iStackSize - 1] = FULL_HEIGHT;
iStack[iStackSize - 2] = FULL_WIDTH;
}
else if ("setSpellPosition".equals(event.getEventName()))
{
if (!config.dragSpells())
{
return;
}
int widget = iStack[iStackSize - 1];
Spell s = spells.get(widget);
int x = s.getX();
int y = s.getY();
if (x == -1)
{
return;
}
iStack[iStackSize - 5] = x;
iStack[iStackSize - 4] = y;
}
}
@Subscribe
public void onWidgetMenuOptionClicked(WidgetMenuOptionClicked event)
{
if (event.getWidget() != WidgetInfo.FIXED_VIEWPORT_MAGIC_TAB
&& event.getWidget() != WidgetInfo.RESIZABLE_VIEWPORT_MAGIC_TAB
&& event.getWidget() != WidgetInfo.RESIZABLE_VIEWPORT_BOTTOM_LINE_MAGIC_TAB)
{
return;
}
if (event.getMenuOption().equals(UNLOCK))
{
config.canDrag(true);
overlayManager.add(overlay);
mouseManager.registerMouseListener(mouseListener);
}
else if (event.getMenuOption().equals(LOCK))
{
config.canDrag(false);
overlayManager.remove(overlay);
mouseManager.unregisterMouseListener(mouseListener);
}
}
private void clearMagicTabMenus()
{
menuManager.removeManagedCustomMenu(FIXED_MAGIC_TAB_LOCK);
menuManager.removeManagedCustomMenu(RESIZABLE_MAGIC_TAB_LOCK);
menuManager.removeManagedCustomMenu(RESIZABLE_BOTTOM_LINE_MAGIC_TAB_LOCK);
menuManager.removeManagedCustomMenu(FIXED_MAGIC_TAB_UNLOCK);
menuManager.removeManagedCustomMenu(RESIZABLE_MAGIC_TAB_UNLOCK);
menuManager.removeManagedCustomMenu(RESIZABLE_BOTTOM_LINE_MAGIC_TAB_UNLOCK);
}
private void refreshMagicTabOption()
{
clearMagicTabMenus();
if (client.getGameState() != GameState.LOGGED_IN || !config.dragSpells())
{
return;
}
if (config.canDrag())
{
menuManager.addManagedCustomMenu(FIXED_MAGIC_TAB_LOCK);
menuManager.addManagedCustomMenu(RESIZABLE_MAGIC_TAB_LOCK);
menuManager.addManagedCustomMenu(RESIZABLE_BOTTOM_LINE_MAGIC_TAB_LOCK);
}
else
{
menuManager.addManagedCustomMenu(FIXED_MAGIC_TAB_UNLOCK);
menuManager.addManagedCustomMenu(RESIZABLE_MAGIC_TAB_UNLOCK);
menuManager.addManagedCustomMenu(RESIZABLE_BOTTOM_LINE_MAGIC_TAB_UNLOCK);
}
}
private void loadFilter()
{
notFilteredSpells.clear();
notFilteredSpells.addAll(Text.fromCSV(config.filter().toLowerCase()));
}
private void loadSpells()
{
if (client.getGameState() != GameState.LOGGED_IN || spellbook == null)
{
return;
}
spells.clear();
String cfg = configManager.getConfiguration("spellbook", spellbook.getConfigKey());
if (Strings.isNullOrEmpty(cfg))
{
return;
}
// CHECKSTYLE:OFF
Collection<Spell> gson = GSON.fromJson(cfg, new TypeToken<List<Spell>>(){}.getType());
// CHECKSTYLE:ON
gson.stream().filter(Objects::nonNull).forEach(s -> spells.put(s.getWidget(), s));
}
private void saveSpells()
{
if (spells.isEmpty())
{
return;
}
String key = spellbook.getConfigKey();
configManager.setConfiguration("spellbook", key, GSON.toJson(spells.values()));
}
private void runRebuild()
{
if (client.getGameState() != GameState.LOGGED_IN)
{
return;
}
// Runs magic_spellbook_rebuild
clientThread.invoke(() ->
client.runScript(2611, 14286851, 14287027, 14287036, 14286849, 14287033, 14287034, 14287035, 14286850, 14287029, 14287032, "Info", "Filters", false)
);
}
boolean isOnSpellWidget(java.awt.Point point)
{
Widget boundsWidget = client.getWidget(WidgetInfo.SPELLBOOK_FILTERED_BOUNDS);
if (boundsWidget == null || !boundsWidget.getBounds().contains(point))
{
return false;
}
for (int id : spells.keySet())
{
Widget w = client.getWidget(WidgetInfo.TO_GROUP(id), WidgetInfo.TO_CHILD(id)); // lol very useful
if (w == null || notFilteredSpells.stream().noneMatch(spells.get(id).getName()::contains))
{
continue;
}
if (w.getBounds().contains(point))
{
return true;
}
}
return false;
}
void startDragging(java.awt.Point point)
{
for (int id : spells.keySet())
{
Widget w = client.getWidget(WidgetInfo.TO_GROUP(id), WidgetInfo.TO_CHILD(id)); // y tho let me just plop in id
if (w == null || !w.getBounds().contains(point) || notFilteredSpells.stream().noneMatch(spells.get(id).getName()::contains))
{
continue;
}
draggingWidget = w;
break;
}
Point widgetPos = draggingWidget.getCanvasLocation();
int x = point.x - widgetPos.getX();
int y = point.y - widgetPos.getY();
draggingLocation = new Point(x, y);
draggingWidget.setHidden(true);
dragging = true;
}
void completeDragging(java.awt.Point point)
{
Point parentPos = client.getWidget(WidgetInfo.SPELLBOOK_FILTERED_BOUNDS).getCanvasLocation();
int x = point.x - draggingLocation.getX() - parentPos.getX();
int y = point.y - draggingLocation.getY() - parentPos.getY();
int size = config.size();
if (x < 0)
{
x = 0;
}
else if (x > FULL_WIDTH - size)
{
x = FULL_WIDTH - size;
}
if (y < 0)
{
y = 0;
}
else if (y > FULL_HEIGHT - size)
{
y = FULL_HEIGHT - size;
}
int draggedID = draggingWidget.getId();
Spell n = spells.get(draggedID);
n.setX(x);
n.setY(y);
spells.replace(draggedID, n);
draggingWidget.setHidden(false);
dragging = false;
saveSpells();
}
}

33
runelite-client/src/main/scripts/MagicSpellBookRedraw.rs2asm
View File

@@ -272,6 +272,21 @@ LABEL239:
iload 17
invoke 2619
iconst 1
if_icmpeq FILTER_SPELL
jump LABEL263
FILTER_SPELL:
iconst 1 ; boolean the callback modifies
iload 17
iconst 596 ; widgetID, to populate config
oc_param
iload 17
iconst 601 ; spell_name
oc_param ; look up from object composition
sconst "shouldFilterSpell"
runelite_callback
pop_string ; pop the name
pop_int ; and the widgetID
iconst 1 ; default true, so the script still functions without plugin on
if_icmpeq LABEL250
jump LABEL263
LABEL250:
@@ -360,7 +375,9 @@ LABEL316:
istore 23
iload 12
istore 24
iload 10
iconst 0
sconst "isMobileSpellbookEnabled"
runelite_callback
iconst 1
if_icmpeq LABEL332
jump LABEL422
@@ -372,6 +389,8 @@ LABEL332:
LABEL336:
iconst 40
iconst 3
sconst "resizeSpell"
runelite_callback
istore 20
istore 19
jump LABEL360
@@ -640,9 +659,11 @@ LABEL577:
iconst 1
sub
iload 23
multiply
add
iload 24
multiply
add ; start of the label until here calcs total width
iload 24 ; total height
sconst "setSpellAreaSize"
runelite_callback
iconst 0
iconst 0
iload 0
@@ -703,7 +724,9 @@ LABEL611:
iconst 0
iconst 0
iload 25
if_setposition
sconst "setSpellPosition"
runelite_callback
if_setposition
iload 17
iload 25
invoke 2614