wiki: Use jagex's sprite, but hide their wiki banner

Ours has more functionality (lookuping items in interfaces, and a
predictive search interface)
This commit is contained in:
Max Weber
2020-01-23 04:58:17 -07:00
parent 2b077f4364
commit 32c8c497bd
8 changed files with 33 additions and 52 deletions

View File

@@ -1589,4 +1589,6 @@ public final class SpriteID
public static final int HEALTHBAR_DEFAULT_BACK_140PX = 2189; public static final int HEALTHBAR_DEFAULT_BACK_140PX = 2189;
public static final int HEALTHBAR_DEFAULT_FRONT_160PX = 2190; public static final int HEALTHBAR_DEFAULT_FRONT_160PX = 2190;
public static final int HEALTHBAR_DEFAULT_BACK_160PX = 2191; public static final int HEALTHBAR_DEFAULT_BACK_160PX = 2191;
public static final int WIKI_DESELECTED = 2420;
public static final int WIKI_SELECTED = 2421;
} }

View File

@@ -306,6 +306,7 @@ public class WidgetID
static final int RUN_ORB_TEXT = 23; static final int RUN_ORB_TEXT = 23;
static final int SPEC_ORB = 28; static final int SPEC_ORB = 28;
static final int WORLDMAP_ORB = 41; static final int WORLDMAP_ORB = 41;
static final int WIKI_BANNER = 43;
} }
static class LoginClickToPlayScreen static class LoginClickToPlayScreen

View File

@@ -155,6 +155,7 @@ public enum WidgetInfo
MINIMAP_HEALTH_ORB(WidgetID.MINIMAP_GROUP_ID, WidgetID.Minimap.HEALTH_ORB), MINIMAP_HEALTH_ORB(WidgetID.MINIMAP_GROUP_ID, WidgetID.Minimap.HEALTH_ORB),
MINIMAP_SPEC_ORB(WidgetID.MINIMAP_GROUP_ID, WidgetID.Minimap.SPEC_ORB), MINIMAP_SPEC_ORB(WidgetID.MINIMAP_GROUP_ID, WidgetID.Minimap.SPEC_ORB),
MINIMAP_WORLDMAP_ORB(WidgetID.MINIMAP_GROUP_ID, WidgetID.Minimap.WORLDMAP_ORB), MINIMAP_WORLDMAP_ORB(WidgetID.MINIMAP_GROUP_ID, WidgetID.Minimap.WORLDMAP_ORB),
MINIMAP_WIKI_BANNER(WidgetID.MINIMAP_GROUP_ID, WidgetID.Minimap.WIKI_BANNER),
LOGIN_CLICK_TO_PLAY_SCREEN(WidgetID.LOGIN_CLICK_TO_PLAY_GROUP_ID, 0), LOGIN_CLICK_TO_PLAY_SCREEN(WidgetID.LOGIN_CLICK_TO_PLAY_GROUP_ID, 0),
LOGIN_CLICK_TO_PLAY_SCREEN_MESSAGE_OF_THE_DAY(WidgetID.LOGIN_CLICK_TO_PLAY_GROUP_ID, WidgetID.LoginClickToPlayScreen.MESSAGE_OF_THE_DAY), LOGIN_CLICK_TO_PLAY_SCREEN_MESSAGE_OF_THE_DAY(WidgetID.LOGIN_CLICK_TO_PLAY_GROUP_ID, WidgetID.LoginClickToPlayScreen.MESSAGE_OF_THE_DAY),

View File

@@ -35,9 +35,11 @@ import net.runelite.api.MenuEntry;
import net.runelite.api.NPC; import net.runelite.api.NPC;
import net.runelite.api.NPCComposition; import net.runelite.api.NPCComposition;
import net.runelite.api.ObjectComposition; import net.runelite.api.ObjectComposition;
import net.runelite.api.SpriteID;
import net.runelite.api.coords.WorldPoint; import net.runelite.api.coords.WorldPoint;
import net.runelite.api.events.MenuEntryAdded; import net.runelite.api.events.MenuEntryAdded;
import net.runelite.api.events.MenuOptionClicked; import net.runelite.api.events.MenuOptionClicked;
import net.runelite.api.events.WidgetHiddenChanged;
import net.runelite.api.events.WidgetLoaded; import net.runelite.api.events.WidgetLoaded;
import net.runelite.api.widgets.JavaScriptCallback; import net.runelite.api.widgets.JavaScriptCallback;
import net.runelite.api.widgets.Widget; import net.runelite.api.widgets.Widget;
@@ -105,14 +107,12 @@ public class WikiPlugin extends Plugin
@Override @Override
public void startUp() public void startUp()
{ {
spriteManager.addSpriteOverrides(WikiSprite.values());
clientThread.invokeLater(this::addWidgets); clientThread.invokeLater(this::addWidgets);
} }
@Override @Override
public void shutDown() public void shutDown()
{ {
spriteManager.removeSpriteOverrides(WikiSprite.values());
clientThread.invokeLater(() -> clientThread.invokeLater(() ->
{ {
Widget minimapOrbs = client.getWidget(WidgetInfo.MINIMAP_ORBS); Widget minimapOrbs = client.getWidget(WidgetInfo.MINIMAP_ORBS);
@@ -127,6 +127,12 @@ public class WikiPlugin extends Plugin
} }
children[0] = null; children[0] = null;
Widget vanilla = client.getWidget(WidgetInfo.MINIMAP_WIKI_BANNER);
if (vanilla != null)
{
vanilla.setHidden(false);
}
onDeselect(); onDeselect();
client.setSpellSelected(false); client.setSpellSelected(false);
}); });
@@ -149,14 +155,20 @@ public class WikiPlugin extends Plugin
return; return;
} }
Widget vanilla = client.getWidget(WidgetInfo.MINIMAP_WIKI_BANNER);
if (vanilla != null)
{
vanilla.setHidden(true);
}
icon = minimapOrbs.createChild(0, WidgetType.GRAPHIC); icon = minimapOrbs.createChild(0, WidgetType.GRAPHIC);
icon.setSpriteId(WikiSprite.WIKI_ICON.getSpriteId()); icon.setSpriteId(SpriteID.WIKI_DESELECTED);
icon.setOriginalX(0); icon.setOriginalX(0);
icon.setOriginalY(2); icon.setOriginalY(0);
icon.setXPositionMode(WidgetPositionMode.ABSOLUTE_RIGHT); icon.setXPositionMode(WidgetPositionMode.ABSOLUTE_RIGHT);
icon.setYPositionMode(WidgetPositionMode.ABSOLUTE_BOTTOM); icon.setYPositionMode(WidgetPositionMode.ABSOLUTE_BOTTOM);
icon.setOriginalWidth(42); icon.setOriginalWidth(40);
icon.setOriginalHeight(16); icon.setOriginalHeight(14);
icon.setTargetVerb("Lookup"); icon.setTargetVerb("Lookup");
icon.setName("Wiki"); icon.setName("Wiki");
icon.setClickMask(WidgetConfig.USE_GROUND_ITEM | WidgetConfig.USE_ITEM | WidgetConfig.USE_NPC icon.setClickMask(WidgetConfig.USE_GROUND_ITEM | WidgetConfig.USE_ITEM | WidgetConfig.USE_NPC
@@ -165,7 +177,7 @@ public class WikiPlugin extends Plugin
icon.setOnTargetEnterListener((JavaScriptCallback) ev -> icon.setOnTargetEnterListener((JavaScriptCallback) ev ->
{ {
wikiSelected = true; wikiSelected = true;
icon.setSpriteId(WikiSprite.WIKI_SELECTED_ICON.getSpriteId()); icon.setSpriteId(SpriteID.WIKI_SELECTED);
client.setAllWidgetsAreOpTargetable(true); client.setAllWidgetsAreOpTargetable(true);
}); });
icon.setAction(5, "Search"); // Start at option 5 so the target op is ontop icon.setAction(5, "Search"); // Start at option 5 so the target op is ontop
@@ -183,6 +195,15 @@ public class WikiPlugin extends Plugin
icon.revalidate(); icon.revalidate();
} }
@Subscribe
private void onWidgetHiddenChanged(WidgetHiddenChanged ev)
{
if (ev.getWidget().getId() == WidgetInfo.MINIMAP_WIKI_BANNER.getId())
{
ev.getWidget().setHidden(true);
}
}
private void onDeselect() private void onDeselect()
{ {
client.setAllWidgetsAreOpTargetable(false); client.setAllWidgetsAreOpTargetable(false);
@@ -190,7 +211,7 @@ public class WikiPlugin extends Plugin
wikiSelected = false; wikiSelected = false;
if (icon != null) if (icon != null)
{ {
icon.setSpriteId(WikiSprite.WIKI_ICON.getSpriteId()); icon.setSpriteId(SpriteID.WIKI_DESELECTED);
} }
} }

View File

@@ -1,44 +0,0 @@
/*
* 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.wiki;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import net.runelite.api.SpriteID;
import net.runelite.client.game.SpriteOverride;
@RequiredArgsConstructor
public enum WikiSprite implements SpriteOverride
{
WIKI_ICON(-300, "wiki.png"),
WIKI_SELECTED_ICON(-301, "wiki_selected.png"),
FIXED_MODE_MINIMAP_CLICKMASK(SpriteID.MINIMAP_CLICK_MASK, "fixed_mode_minimap_clickmask.png");
@Getter
private final int spriteId;
@Getter
private final String fileName;
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.0 KiB