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

Merge pull request #3838 from Abextm/fairy-ring-search

Browse Source 
Fairy ring search
This commit is contained in:
Adam
2018-07-17 21:38:41 -04:00
committed by GitHub
parent ddc14df306 181c4a0abf
commit 6bd7739fb4
15 changed files with 732 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
runelite-api/src/main/java/net/runelite/api/ScriptID.java
View File

@@ -26,6 +26,48 @@ package net.runelite.api;
public final class ScriptID
{
/**
* Updates the scrollbar handle and container to the new height of the content container
* <ul>
* <li> int (WidgetID) Scrollbar's widget ID </li>
* <li> int (WidgetID) Container widget ID </li>
* <li> int how far down to scroll </li>
* </ul>
*/
public static final int UPDATE_SCROLLBAR = 72;
/**
* Sends a chat message
* <ul>
* <li> int (byte) Flags </li>
* <li> String Message to send </li>
* </ul>
*/
public static final int CHATBOX_INPUT = 96;
/**
* Closes the chatbox input
* <ul>
* <li> int (boolean) Clear the current text </li>
* <li> int (boolean) Unknown; set to 1 </li>
* </ul>
*/
public static final int CLOSE_CHATBOX_INPUT = 299;
/**
* Initializes the chatbox input to use RuneLite callbacks
* <ul>
* <li> String Prompt text </li>
* <li> String Default value </li>
* </ul>
*/
public static final int RUNELITE_CHATBOX_INPUT_INIT = 10001;
/**
* Does nothing
*
* This is used to eat events when you want a menu action attached to it
* because you need an op listener attached to it for it to work
*/
public static final int NULL = 10003;
}

30
runelite-api/src/main/java/net/runelite/api/WidgetType.java Normal file
View File

@@ -0,0 +1,30 @@
/*
* Copyright (c) 2018 Abex
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.api;
public final class WidgetType
{
public static final int GRAPHIC = 5;
}

86
runelite-api/src/main/java/net/runelite/api/widgets/Widget.java
View File

@@ -267,6 +267,11 @@ public interface Widget
*/
void setHidden(boolean hidden);
/**
* The index of this widget in it's parent's children array
*/
int getIndex();
/**
* Gets the location the widget is being drawn on the canvas.
* <p>
@@ -354,14 +359,46 @@ public interface Widget
*/
boolean contains(Point point);
/**
* Gets the amount of pixels the widget is scrolled in the X axis
*/
int getScrollX();
/**
* Sets the amount of pixels the widget is scrolled in the X axis
*/
void setScrollX(int scrollX);
/**
* Gets the amount of pixels the widget is scrolled in the Y axis
*/
int getScrollY();
/**
* sets the amount of pixels the widget is scrolled in the Y axis
*/
void setScrollY(int scrollY);
/**
* Gets the size of the widget's viewport in the X axis
*/
int getScrollWidth();
/**
* Sets the size of the widget's viewport in the X axis
*/
void setScrollWidth(int width);
/**
* Gets the size of the widget's viewport in the Y axis
*/
int getScrollHeight();
/**
* Sets the size of the widget's viewport in the Y axis
*/
void setScrollHeight(int height);
/**
* Gets the original x-axis coordinate.
*
@@ -452,4 +489,53 @@ public interface Widget
* @return the actions
*/
String[] getActions();
/**
* Creates a dynamic widget child
*
* @param index the index of the new widget in the children list or -1 to append to the back
* @param type the type of the widget
*/
Widget createChild(int index, int type);
/**
* Creates a menu action on the widget
*
* @param index The index of the menu
* @param action The string to be displayed next to the widget's name in the context menu
*/
void setAction(int index, String action);
/**
* Sets a script to be ran when the a menu action is clicked.
* hasListener must be true for this to take effect
*
* @param args A ScriptID, then the args for the script
*/
void setOnOpListener(Object ...args);
/**
* If this widget has any listeners on it
*/
boolean hasListener();
/**
* Sets if the widget has any listeners. This should be called whenever a setXListener function is called
*/
void setHasListener(boolean hasListener);
/**
* This is true if the widget is from an if3 interface, or is dynamically created
*/
boolean isIf3();
/**
* Recomputes this widget's x/y/w/h, excluding scroll
*/
void revalidate();
/**
* Recomputes this widget's group's x/y/w/h including scroll
*/
void revalidateScroll();
}

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

@@ -36,7 +36,7 @@ package net.runelite.api.widgets;
*/
public class WidgetID
{
public static final int FAIRY_RING_CODE_GROUP_ID = 381;
public static final int FAIRY_RING_PANEL_GROUP_ID = 381;
public static final int FAIRY_RING_GROUP_ID = 398;
public static final int LOGOUT_PANEL_ID = 182;
public static final int BANK_GROUP_ID = 12;
@@ -510,6 +510,15 @@ public class WidgetID
static final int BOTTOM_BAR = 14;
}
static class FairyRingPanel
{
static final int HEADER = 2;
static final int LIST = 7;
static final int FAVORITES = 8;
static final int SEPARATOR = 9;
static final int SCROLLBAR = 152;
}
static class FairyRing
{
static final int LEFT_ORB_CLOCKWISE = 19;

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

@@ -31,8 +31,6 @@ package net.runelite.api.widgets;
*/
public enum WidgetInfo
{
FAIRY_QUEEN_HIDEOUT_CODE(WidgetID.FAIRY_RING_CODE_GROUP_ID, WidgetID.FairyRingCode.FAIRY_QUEEN_HIDEOUT),
FAIRY_RING_LEFT_ORB_CLOCKWISE(WidgetID.FAIRY_RING_GROUP_ID, WidgetID.FairyRing.LEFT_ORB_CLOCKWISE),
FAIRY_RING_LEFT_ORB_COUNTER_CLOCKWISE(WidgetID.FAIRY_RING_GROUP_ID, WidgetID.FairyRing.LEFT_ORB_COUNTER_CLOCKWISE),
FAIRY_RING_MIDDLE_ORB_CLOCKWISE(WidgetID.FAIRY_RING_GROUP_ID, WidgetID.FairyRing.MIDDLE_ORB_CLOCKWISE),
@@ -346,6 +344,14 @@ public enum WidgetInfo
MTA_ENCHANTMENT_BONUS_TEXT(WidgetID.MTA_ENCHANTMENT_GROUP_ID, WidgetID.MTA.BONUS_TEXT_COMPONENT),
MTA_ENCHANTMENT_BONUS(WidgetID.MTA_ENCHANTMENT_GROUP_ID, WidgetID.MTA.BONUS_COMPONENT),
FAIRY_RING(WidgetID.FAIRY_RING_GROUP_ID, 0),
FAIRY_RING_HEADER(WidgetID.FAIRY_RING_PANEL_GROUP_ID, WidgetID.FairyRingPanel.HEADER),
FAIRY_RING_LIST(WidgetID.FAIRY_RING_PANEL_GROUP_ID, WidgetID.FairyRingPanel.LIST),
FAIRY_RING_FAVORITES(WidgetID.FAIRY_RING_PANEL_GROUP_ID, WidgetID.FairyRingPanel.FAVORITES),
FAIRY_RING_LIST_SEPARATOR(WidgetID.FAIRY_RING_PANEL_GROUP_ID, WidgetID.FairyRingPanel.SEPARATOR),
FAIRY_RING_LIST_SCROLLBAR(WidgetID.FAIRY_RING_PANEL_GROUP_ID, WidgetID.FairyRingPanel.SCROLLBAR),
DESTROY_ITEM(WidgetID.DESTROY_ITEM_GROUP_ID, 0),
DESTROY_ITEM_NAME(WidgetID.DESTROY_ITEM_GROUP_ID, WidgetID.DestroyItem.DESTROY_ITEM_NAME),
DESTROY_ITEM_YES(WidgetID.DESTROY_ITEM_GROUP_ID, WidgetID.DestroyItem.DESTROY_ITEM_YES),

46
runelite-client/src/main/java/net/runelite/client/game/ChatboxInputManager.java
View File

@@ -29,6 +29,7 @@ import com.google.common.eventbus.Subscribe;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.util.function.Consumer;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.ScriptID;
@@ -39,13 +40,17 @@ import net.runelite.client.callback.ClientThread;
@Slf4j
public class ChatboxInputManager
{
private static final int NO_LIMIT = Integer.MAX_VALUE;
public static final int NO_LIMIT = Integer.MAX_VALUE;
private final Client client;
private final ClientThread clientThread;
private Consumer<String> done;
private Consumer<String> changed;
private int characterLimit = NO_LIMIT;
@Getter
private boolean open = false;
@Inject
public ChatboxInputManager(Client client, ClientThread clientThread, EventBus eventBus)
{
@@ -67,9 +72,16 @@ public class ChatboxInputManager
}
public void openInputWindow(String text, String defaul, int characterLimit, Consumer<String> done)
{
openInputWindow(text, defaul, characterLimit, null, done);
}
public void openInputWindow(String text, String defaul, int characterLimit, Consumer<String> changed, Consumer<String> done)
{
this.done = done;
this.changed = changed;
this.characterLimit = characterLimit;
this.open = true;
clientThread.invokeLater(() -> client.runScript(
ScriptID.RUNELITE_CHATBOX_INPUT_INIT,
text,
@@ -77,6 +89,23 @@ public class ChatboxInputManager
));
}
/**
* Closes the RuneScape-style chatbox input
*/
public void closeInputWindow()
{
if (!this.open)
{
return;
}
this.open = false;
clientThread.invokeLater(() -> client.runScript(
ScriptID.CLOSE_CHATBOX_INPUT,
1,
1
));
}
@Subscribe
public void scriptCallback(ScriptCallbackEvent ev)
{
@@ -93,9 +122,17 @@ public class ChatboxInputManager
{
case 27: // Escape
str = "";
if (changed != null)
{
changed.accept(str);
}
// fallthrough
case '\n':
done.accept(str);
if (done != null)
{
done.accept(str);
}
this.open = false;
retval = 1;
break;
case '\b':
@@ -111,6 +148,11 @@ public class ChatboxInputManager
}
}
if (changed != null)
{
changed.accept(str);
}
client.getStringStack()[stringStackSize++] = str;
client.getIntStack()[intStackSize++] = retval;
client.setIntStackSize(intStackSize);

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

@@ -134,12 +134,16 @@ public class WidgetInfoTableModel extends AbstractTableModel
out.add(new WidgetField<>("RelativeY", Widget::getRelativeY, Widget::setRelativeY, Integer.class));
out.add(new WidgetField<>("CanvasLocation", Widget::getCanvasLocation));
out.add(new WidgetField<>("Bounds", Widget::getBounds));
out.add(new WidgetField<>("ScrollX", Widget::getScrollX));
out.add(new WidgetField<>("ScrollY", Widget::getScrollY));
out.add(new WidgetField<>("ScrollX", Widget::getScrollX, Widget::setScrollX, Integer.class));
out.add(new WidgetField<>("ScrollY", Widget::getScrollY, Widget::setScrollY, Integer.class));
out.add(new WidgetField<>("ScrollWidth", Widget::getScrollWidth, Widget::setScrollWidth, Integer.class));
out.add(new WidgetField<>("ScrollHeight", Widget::getScrollHeight, Widget::setScrollHeight, Integer.class));
out.add(new WidgetField<>("OriginalX", Widget::getOriginalX));
out.add(new WidgetField<>("OriginalY", Widget::getOriginalY));
out.add(new WidgetField<>("PaddingX", Widget::getPaddingX));
out.add(new WidgetField<>("PaddingY", Widget::getPaddingY));
out.add(new WidgetField<>("IsIf3", Widget::isIf3));
out.add(new WidgetField<>("HasListener", Widget::hasListener, Widget::setHasListener, Boolean.class));
return out;
}

15
runelite-client/src/main/java/net/runelite/client/plugins/devtools/WidgetTreeNode.java
View File

@@ -49,8 +49,21 @@ class WidgetTreeNode extends DefaultMutableTreeNode
public String toString()
{
Widget widget = getWidget();
int id = widget.getId();
String str = type + " " + TO_GROUP(id) + "." + TO_CHILD(id);
if (widget.getIndex() != -1)
{
str += "[" + widget.getIndex() + "]";
}
WidgetInfo info = WidgetInspector.getWidgetInfo(id);
return type + " " + TO_GROUP(id) + "." + TO_CHILD(id) + ((info != null) ? " " + info.name() : "");
if (info != null)
{
str += " " + info.name();
}
return str;
}
}

43
runelite-client/src/main/java/net/runelite/client/plugins/fairyring/FairyRingConfig.java Normal file
View File

@@ -0,0 +1,43 @@
/*
* Copyright (c) 2018 Abex
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.plugins.fairyring;
import net.runelite.client.config.Config;
import net.runelite.client.config.ConfigGroup;
import net.runelite.client.config.ConfigItem;
@ConfigGroup("fairyrings")
public interface FairyRingConfig extends Config
{
@ConfigItem(
keyName = "autoOpen",
name = "Open search automatically",
description = "Open the search widget every time you enter a fairy ring"
)
default boolean autoOpen()
{
return true;
}
}

279
runelite-client/src/main/java/net/runelite/client/plugins/fairyring/FairyRingPlugin.java
View File

@@ -1,4 +1,6 @@
/*
* Copyright (c) 2018 Abex
* Copyright (c) 2017, Tyler <https://github.com/tylerthardy>
* Copyright (c) 2018, Yoav Ram <https://github.com/yoyo421>
* Copyright (c) 2018, Infinitay <https://github.com/Infinitay>
* All rights reserved.
@@ -26,20 +28,38 @@
package net.runelite.client.plugins.fairyring;
import com.google.common.base.Strings;
import com.google.common.eventbus.Subscribe;
import com.google.inject.Provides;
import java.util.Collection;
import java.util.Map;
import java.util.TreeMap;
import javax.annotation.Nullable;
import javax.inject.Inject;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.ScriptID;
import net.runelite.api.SoundEffectID;
import net.runelite.api.SpriteID;
import net.runelite.api.Varbits;
import net.runelite.api.WidgetType;
import net.runelite.api.events.GameTick;
import net.runelite.api.events.MenuOptionClicked;
import net.runelite.api.events.VarbitChanged;
import net.runelite.api.events.WidgetLoaded;
import net.runelite.api.widgets.Widget;
import net.runelite.api.widgets.WidgetID;
import net.runelite.api.widgets.WidgetInfo;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.game.ChatboxInputManager;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.util.Text;
@Slf4j
@PluginDescriptor(
name = "Fairy Ring Helper",
name = "Fairy Rings",
description = "Show the location of the fairy ring teleport",
tags = {"teleportation"}
)
@@ -49,9 +69,44 @@ public class FairyRingPlugin extends Plugin
private static final String[] middleDial = new String[]{"I", "L", "K", "J"};
private static final String[] rightDial = new String[]{"P", "S", "R", "Q"};
private static final int ENTRY_PADDING = 3;
private static final String MENU_OPEN = "Open";
private static final String MENU_CLOSE = "Close";
@Inject
private Client client;
@Inject
private FairyRingConfig config;
@Inject
private ChatboxInputManager chatboxInputManager;
private Widget searchBtn;
private boolean chatboxOpenLastTick = false;
private boolean clearFilter = false;
private Collection<CodeWidgets> codes = null;
@Data
private static class CodeWidgets
{
// The fairy hideout has both of these null, because its not the same as the rest of them
@Nullable
private Widget favorite;
@Nullable
private Widget code;
private Widget description;
}
@Provides
FairyRingConfig getConfig(ConfigManager configManager)
{
return configManager.getConfig(FairyRingConfig.class);
}
@Subscribe
public void onVarbitChanged(VarbitChanged event)
{
@@ -61,9 +116,55 @@ public class FairyRingPlugin extends Plugin
@Subscribe
public void onWidgetLoaded(WidgetLoaded widgetLoaded)
{
if (widgetLoaded.getGroupId() == WidgetID.FAIRY_RING_CODE_GROUP_ID)
if (widgetLoaded.getGroupId() == WidgetID.FAIRY_RING_PANEL_GROUP_ID)
{
setWidgetTextToDestination();
Widget header = client.getWidget(WidgetInfo.FAIRY_RING_HEADER);
if (header != null)
{
searchBtn = header.createChild(-1, WidgetType.GRAPHIC);
searchBtn.setSpriteId(SpriteID.GE_SEARCH);
searchBtn.setOriginalWidth(17);
searchBtn.setOriginalHeight(17);
searchBtn.setOriginalX(11);
searchBtn.setOriginalY(11);
searchBtn.setOnOpListener(ScriptID.NULL);
searchBtn.setHasListener(true);
searchBtn.setAction(1, MENU_OPEN);
searchBtn.setName("Search");
searchBtn.revalidate();
codes = null;
if (config.autoOpen())
{
openSearch();
}
}
}
}
@Subscribe
public void onMenuOptionClicked(MenuOptionClicked ev)
{
if (searchBtn != null && searchBtn.getId() == ev.getWidgetId())
{
switch (ev.getMenuOption())
{
case MENU_OPEN:
ev.consume();
openSearch();
client.playSoundEffect(SoundEffectID.UI_BOOP);
break;
case MENU_CLOSE:
ev.consume();
updateFilter("");
searchBtn.setAction(1, MENU_OPEN);
chatboxInputManager.closeInputWindow();
client.playSoundEffect(SoundEffectID.UI_BOOP);
break;
}
}
}
@@ -92,4 +193,178 @@ public class FairyRingPlugin extends Plugin
{
return FairyRings.valueOf(leftDial[varbitValueDialLeft] + middleDial[varbitValueDialMiddle] + rightDial[varbitValueDialRight]);
}
private void openSearch()
{
updateFilter("");
searchBtn.setAction(1, MENU_CLOSE);
chatboxInputManager.openInputWindow("Filter fairy rings", "", ChatboxInputManager.NO_LIMIT, this::updateFilter, s ->
{
// We can't run it right now because scripts can't run other scripts in their callbacks
clearFilter = true;
searchBtn.setAction(1, MENU_OPEN);
});
}
@Subscribe
public void onGameTick(GameTick t)
{
if (clearFilter)
{
updateFilter("");
clearFilter = false;
}
// This has to happen because the only widget that gets hidden is the tli one
Widget fairyRingTeleportButton = client.getWidget(WidgetInfo.FAIRY_RING_TELEPORT_BUTTON);
boolean fairyRingWidgetOpen = fairyRingTeleportButton != null && !fairyRingTeleportButton.isHidden();
boolean chatboxOpen = chatboxInputManager.isOpen();
if (!fairyRingWidgetOpen && chatboxOpen && chatboxOpenLastTick)
{
searchBtn.setAction(1, MENU_OPEN);
chatboxInputManager.closeInputWindow();
}
chatboxOpenLastTick = chatboxOpen && fairyRingWidgetOpen;
}
private void updateFilter(String filter)
{
filter = filter.toLowerCase();
final Widget list = client.getWidget(WidgetInfo.FAIRY_RING_LIST);
final Widget favorites = client.getWidget(WidgetInfo.FAIRY_RING_FAVORITES);
if (list == null)
{
return;
}
if (codes != null)
{
// Check to make sure the list hasn't been rebuild since we were last her
// Do this by making sure the list's dynamic children are the same as when we last saw them
if (codes.stream().noneMatch(w ->
{
Widget codeWidget = w.getCode();
if (codeWidget == null)
{
return false;
}
return list.getChild(codeWidget.getIndex()) == codeWidget;
}))
{
codes = null;
}
}
if (codes == null)
{
// Find all of the widgets that we care about, grouping by their Y value
Map<Integer, CodeWidgets> codeMap = new TreeMap<>();
for (Widget w : list.getStaticChildren())
{
if (w.isSelfHidden())
{
continue;
}
if (w.getSpriteId() != -1)
{
codeMap.computeIfAbsent(w.getRelativeY(), k -> new CodeWidgets()).setFavorite(w);
}
else if (!Strings.isNullOrEmpty(w.getText()))
{
codeMap.computeIfAbsent(w.getRelativeY(), k -> new CodeWidgets()).setDescription(w);
}
}
for (Widget w : list.getDynamicChildren())
{
if (w.isSelfHidden())
{
continue;
}
CodeWidgets c = codeMap.computeIfAbsent(w.getRelativeY(), k -> new CodeWidgets());
c.setCode(w);
}
codes = codeMap.values();
}
// Relayout the panel
int y = 0;
if (favorites != null)
{
boolean hide = !filter.isEmpty();
favorites.setHidden(hide);
if (!hide)
{
y += favorites.getOriginalHeight() + ENTRY_PADDING;
}
}
for (CodeWidgets c : codes)
{
String code = Text.removeTags(c.getDescription().getName()).replaceAll(" ", "");
String tags = null;
if (code.length() > 0)
{
try
{
FairyRings ring = FairyRings.valueOf(code);
tags = ring.getTags();
}
catch (IllegalArgumentException e)
{
log.warn("Unable to find ring with code '{}'", code, e);
}
}
boolean hidden = !(filter.isEmpty()
|| Text.removeTags(c.getDescription().getText()).toLowerCase().contains(filter)
|| code.toLowerCase().contains(filter)
|| tags != null && tags.contains(filter));
if (c.getCode() != null)
{
c.getCode().setHidden(hidden);
c.getCode().setOriginalY(y);
}
if (c.getFavorite() != null)
{
c.getFavorite().setHidden(hidden);
c.getFavorite().setOriginalY(y);
}
c.getDescription().setHidden(hidden);
c.getDescription().setOriginalY(y);
if (!hidden)
{
y += c.getDescription().getHeight() + ENTRY_PADDING;
}
}
y -= ENTRY_PADDING;
if (y < 0)
{
y = 0;
}
list.setScrollHeight(y);
list.revalidateScroll();
client.runScript(
ScriptID.UPDATE_SCROLLBAR,
WidgetInfo.FAIRY_RING_LIST_SCROLLBAR.getId(),
WidgetInfo.FAIRY_RING_LIST.getId(),
0
);
}
}

21
runelite-client/src/main/java/net/runelite/client/plugins/fairyring/FairyRings.java
View File

@@ -26,10 +26,8 @@
package net.runelite.client.plugins.fairyring;
import lombok.AllArgsConstructor;
import lombok.Getter;
@AllArgsConstructor
public enum FairyRings
{
// A
@@ -50,7 +48,7 @@ public enum FairyRings
BIQ("Kalphite Hive"),
BIS("Ardougne Zoo - Unicorns"),
BJR("Realm of the Fisher King"),
BJS("(Island) Near Zul-Andra"),
BJS("(Island) Near Zul-Andra", "zulrah"),
BKP("South of Castle Wars"),
BKQ("Enchanted Valley"),
BKR("Mort Myre Swamp, south of Canifis"),
@@ -73,7 +71,7 @@ public enum FairyRings
// D
DIP("(Sire Boss) Abyssal Nexus"),
DIR("Gorak's Plane"),
DIQ("Player-owned house"),
DIQ("Player-owned house", "poh home"),
DIS("Wizards' Tower"),
DJP("Tower of Life"),
DJR("Chasm of Fire"),
@@ -86,4 +84,19 @@ public enum FairyRings
@Getter
private final String destination;
@Getter
private final String tags;
FairyRings(String destination)
{
this(destination, "");
}
FairyRings(String destination, String tags)
{
this.destination = destination;
this.tags = tags.toLowerCase() + " " + destination.toLowerCase();
}
}

58
runelite-mixins/src/main/java/net/runelite/mixins/RSWidgetMixin.java
View File

@@ -477,4 +477,62 @@ public abstract class RSWidgetMixin implements RSWidget
WidgetPositioned widgetPositioned = new WidgetPositioned();
client.getCallbacks().postDeferred(widgetPositioned);
}
@Inject
@Override
public Widget createChild(int index, int type)
{
RSWidget w = client.createWidget();
w.setType(type);
w.setParentId(getId());
w.setId(getId());
w.setIsIf3(true);
RSWidget[] siblings = getChildren();
if (index < 0)
{
if (siblings == null)
{
index = 0;
}
else
{
index = siblings.length;
}
}
if (siblings == null)
{
siblings = new RSWidget[index + 1];
setChildren(siblings);
}
else if (siblings.length <= index)
{
RSWidget[] newSiblings = new RSWidget[index + 1];
System.arraycopy(siblings, 0, newSiblings, 0, siblings.length);
siblings = newSiblings;
setChildren(siblings);
}
siblings[index] = w;
w.setIndex(index);
return w;
}
@Inject
@Override
public void revalidate()
{
client.revalidateWidget(this);
}
@Inject
@Override
public void revalidateScroll()
{
client.revalidateWidget(this);
client.revalidateWidgetScroll(client.getWidgets()[TO_GROUP(this.getId())], this, false);
}
}

37
runelite-scripts/scripts/null.rs2asm Normal file
View File

@@ -0,0 +1,37 @@
; Copyright (c) 2018 Abex
; All rights reserved.
;
; Redistribution and use in source and binary forms, with or without
; modification, are permitted provided that the following conditions are met:
;
; 1. Redistributions of source code must retain the above copyright notice, this
; list of conditions and the following disclaimer.
; 2. Redistributions in binary form must reproduce the above copyright notice,
; this list of conditions and the following disclaimer in the documentation
; and/or other materials provided with the distribution.
;
; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
; ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
; DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
; ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
; (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
;;
; Does nothing
;
; This is used to eat events when you want a menu action attached to it
; because you need an op listener attached to it for it to work
;;
.id 10003
.int_stack_count 0
.string_stack_count 0
.int_var_count 0
.string_var_count 0
return

9
runescape-api/src/main/java/net/runelite/rs/api/RSClient.java
View File

@@ -648,4 +648,13 @@ public interface RSClient extends RSGameEngine, Client
RSItem getLastItemDespawn();
void setLastItemDespawn(RSItem lastItemDespawn);
@Construct
RSWidget createWidget();
@Import("revalidateWidget")
void revalidateWidget(Widget w);
@Import("revalidateWidgetScroll")
void revalidateWidgetScroll(Widget[] group, Widget w, boolean postEvent);
}

51
runescape-api/src/main/java/net/runelite/rs/api/RSWidget.java
View File

@@ -36,6 +36,9 @@ public interface RSWidget extends Widget
@Override
RSWidget[] getChildren();
@Import("children")
void setChildren(RSWidget[] children);
@Import("id")
@Override
int getId();
@@ -46,9 +49,15 @@ public interface RSWidget extends Widget
void setRenderY(int y);
@Import("id")
void setId(int id);
@Import("parentId")
int getRSParentId();
@Import("parentId")
void setParentId(int id);
@Import("clickMask")
int getClickMask();
@@ -141,6 +150,9 @@ public interface RSWidget extends Widget
@Import("index")
int getIndex();
@Import("index")
void setIndex(int index);
@Import("rotationX")
int getRotationX();
@@ -182,6 +194,22 @@ public interface RSWidget extends Widget
@Override
void setScrollY(int scrollY);
@Import("scrollWidth")
@Override
int getScrollWidth();
@Import("scrollWidth")
@Override
void setScrollWidth(int width);
@Import("scrollHeight")
@Override
int getScrollHeight();
@Import("scrollHeight")
@Override
void setScrollHeight(int height);
@Import("spriteId")
@Override
int getSpriteId();
@@ -250,4 +278,27 @@ public interface RSWidget extends Widget
void setPaddingY(int paddingY);
void broadcastHidden(boolean hidden);
@Import("onOpListener")
@Override
void setOnOpListener(Object ...args);
@Import("setAction")
@Override
void setAction(int idx, String action);
@Import("isIf3")
@Override
boolean isIf3();
@Import("isIf3")
void setIsIf3(boolean isIf3);
@Import("hasListener")
@Override
boolean hasListener();
@Import("hasListener")
@Override
void setHasListener(boolean hasListener);
}