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

Merge pull request #1364 from jplsek/ge-alt-tooltip2

Browse Source 
Add tooltips when pressing ALT for searching the GE
This commit is contained in:
Adam
2018-04-20 09:59:51 -04:00
committed by GitHub
parent 10946412ec aea92e9a49
commit 31b8ef6adf
2 changed files with 244 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
runelite-client/src/main/java/net/runelite/client/plugins/grandexchange/GrandExchangeInputListener.java Normal file
View File

@@ -0,0 +1,176 @@
/*
* Copyright (c) 2018, Jeremy Plsek <https://github.com/jplsek>
* 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.grandexchange;
import java.awt.event.KeyEvent;
import java.awt.event.MouseEvent;
import javax.inject.Inject;
import javax.swing.SwingUtilities;
import net.runelite.api.Client;
import net.runelite.api.ItemComposition;
import net.runelite.api.Point;
import net.runelite.api.queries.BankItemQuery;
import net.runelite.api.widgets.Widget;
import net.runelite.api.widgets.WidgetInfo;
import net.runelite.api.widgets.WidgetItem;
import net.runelite.client.game.ItemManager;
import net.runelite.client.input.KeyListener;
import net.runelite.client.input.MouseListener;
import net.runelite.client.util.QueryRunner;
public class GrandExchangeInputListener extends MouseListener implements KeyListener
{
private final Client client;
private final GrandExchangePlugin plugin;
private final ItemManager itemManager;
private final QueryRunner queryRunner;
@Inject
GrandExchangeInputListener(Client client, GrandExchangePlugin plugin, ItemManager itemManager,
QueryRunner queryRunner)
{
this.client = client;
this.plugin = plugin;
this.itemManager = itemManager;
this.queryRunner = queryRunner;
}
@Override
public MouseEvent mouseClicked(MouseEvent e)
{
// Check if left click + alt
if (e.getButton() == MouseEvent.BUTTON1 && e.isAltDown())
{
Widget inventoryWidget = client.getWidget(WidgetInfo.INVENTORY);
if (inventoryWidget != null && !inventoryWidget.isHidden())
{
if (findAndSearch(inventoryWidget.getWidgetItems().toArray(new WidgetItem[0])))
{
e.consume();
return super.mouseClicked(e);
}
}
// Check the inventory when the bank is open aswell
Widget bankInventoryWidget = client.getWidget(WidgetInfo.BANK_INVENTORY_ITEMS_CONTAINER);
if (bankInventoryWidget != null && !bankInventoryWidget.isHidden())
{
if (findAndSearch(bankInventoryWidget.getDynamicChildren()))
{
e.consume();
return super.mouseClicked(e);
}
}
Widget bankWidget = client.getWidget(WidgetInfo.BANK_ITEM_CONTAINER);
if (bankWidget != null && !bankWidget.isHidden())
{
// Use bank item query for only checking the active tab
WidgetItem[] items = queryRunner.runQuery(new BankItemQuery());
if (findAndSearch(items))
{
e.consume();
return super.mouseClicked(e);
}
}
}
return super.mouseClicked(e);
}
private boolean findAndSearch(Widget[] widgets)
{
Point mousePosition = client.getMouseCanvasPosition();
for (Widget widget : widgets)
{
if (widget.getBounds().contains(mousePosition.getX(), mousePosition.getY()))
{
ItemComposition itemComposition = itemManager.getItemComposition(widget.getItemId());
search(itemComposition);
return true;
}
}
return false;
}
/**
* Finds the item clicked based on the mouse location
* @param items
* @return true if an item is found, false otherwise
*/
private boolean findAndSearch(WidgetItem[] items)
{
Point mousePosition = client.getMouseCanvasPosition();
for (WidgetItem item : items)
{
if (item.getCanvasBounds().contains(mousePosition.getX(), mousePosition.getY()))
{
ItemComposition itemComposition = itemManager.getItemComposition(item.getId());
search(itemComposition);
return true;
}
}
return false;
}
private void search(ItemComposition itemComposition)
{
SwingUtilities.invokeLater(() ->
{
plugin.getPanel().showSearch();
if (!plugin.getButton().isSelected())
{
plugin.getButton().getOnSelect().run();
}
plugin.getPanel().getSearchPanel().priceLookup(itemComposition.getName());
});
}
@Override
public void keyTyped(KeyEvent e)
{
}
@Override
public void keyPressed(KeyEvent e)
{
if (e.isAltDown())
{
plugin.setHotKeyPressed(true);
}
}
@Override
public void keyReleased(KeyEvent e)
{
if (!e.isAltDown())
{
plugin.setHotKeyPressed(false);
}
}
}

174
runelite-client/src/main/java/net/runelite/client/plugins/grandexchange/GrandExchangePlugin.java
View File

@@ -29,25 +29,28 @@ package net.runelite.client.plugins.grandexchange;
import com.google.common.eventbus.Subscribe; import com.google.common.eventbus.Subscribe;
import com.google.inject.Provides; import com.google.inject.Provides;
import java.awt.event.MouseEvent;
import java.awt.image.BufferedImage; import java.awt.image.BufferedImage;
import java.io.IOException; import java.io.IOException;
import javax.imageio.ImageIO; import javax.imageio.ImageIO;
import javax.inject.Inject; import javax.inject.Inject;
import javax.swing.SwingUtilities; import javax.swing.SwingUtilities;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
import net.runelite.api.Client; import net.runelite.api.Client;
import net.runelite.api.GameState;
import net.runelite.api.GrandExchangeOffer; import net.runelite.api.GrandExchangeOffer;
import net.runelite.api.ItemComposition; import net.runelite.api.ItemComposition;
import net.runelite.api.Point; import net.runelite.api.MenuEntry;
import net.runelite.api.events.ConfigChanged; import net.runelite.api.events.ConfigChanged;
import net.runelite.api.events.FocusChanged;
import net.runelite.api.events.GrandExchangeOfferChanged; import net.runelite.api.events.GrandExchangeOfferChanged;
import net.runelite.api.queries.BankItemQuery; import net.runelite.api.events.MenuEntryAdded;
import net.runelite.api.widgets.Widget; import net.runelite.api.widgets.WidgetID;
import net.runelite.api.widgets.WidgetInfo; import net.runelite.api.widgets.WidgetInfo;
import net.runelite.api.widgets.WidgetItem;
import net.runelite.client.config.ConfigManager; import net.runelite.client.config.ConfigManager;
import net.runelite.client.game.ItemManager; import net.runelite.client.game.ItemManager;
import net.runelite.client.input.MouseListener; import net.runelite.client.input.KeyManager;
import net.runelite.client.input.MouseManager; import net.runelite.client.input.MouseManager;
import net.runelite.client.plugins.Plugin; import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor; import net.runelite.client.plugins.PluginDescriptor;
@@ -59,11 +62,18 @@ import net.runelite.client.ui.PluginToolbar;
) )
public class GrandExchangePlugin extends Plugin public class GrandExchangePlugin extends Plugin
{ {
@Getter(AccessLevel.PACKAGE)
private NavigationButton button; private NavigationButton button;
@Getter(AccessLevel.PACKAGE)
private GrandExchangePanel panel; private GrandExchangePanel panel;
private MouseListener itemClick; @Getter(AccessLevel.PACKAGE)
@Setter(AccessLevel.PACKAGE)
private boolean hotKeyPressed;
@Inject
private GrandExchangeInputListener inputListener;
@Inject @Inject
private ItemManager itemManager; private ItemManager itemManager;
@@ -71,6 +81,9 @@ public class GrandExchangePlugin extends Plugin
@Inject @Inject
private MouseManager mouseManager; private MouseManager mouseManager;
@Inject
private KeyManager keyManager;
@Inject @Inject
private Client client; private Client client;
@@ -105,104 +118,10 @@ public class GrandExchangePlugin extends Plugin
pluginToolbar.addNavigation(button); pluginToolbar.addNavigation(button);
itemClick = new MouseListener()
{
@Override
public MouseEvent mouseClicked(MouseEvent e)
{
// Check if left click + alt
if (e.getButton() == MouseEvent.BUTTON1 && e.isAltDown())
{
Widget inventoryWidget = client.getWidget(WidgetInfo.INVENTORY);
if (inventoryWidget != null && !inventoryWidget.isHidden())
{
if (findAndSearch(inventoryWidget.getWidgetItems().toArray(new WidgetItem[0])))
{
e.consume();
return super.mouseClicked(e);
}
}
// Check the inventory when the bank is open aswell
Widget bankInventoryWidget = client.getWidget(WidgetInfo.BANK_INVENTORY_ITEMS_CONTAINER);
if (bankInventoryWidget != null && !bankInventoryWidget.isHidden())
{
if (findAndSearch(bankInventoryWidget.getDynamicChildren()))
{
e.consume();
return super.mouseClicked(e);
}
}
Widget bankWidget = client.getWidget(WidgetInfo.BANK_ITEM_CONTAINER);
if (bankWidget != null && !bankWidget.isHidden())
{
// Use bank item query for only checking the active tab
if (findAndSearch(new BankItemQuery().result(client)))
{
e.consume();
return super.mouseClicked(e);
}
}
}
return super.mouseClicked(e);
}
private boolean findAndSearch(Widget[] widgets)
{
Point mousePosition = client.getMouseCanvasPosition();
for (Widget widget : widgets)
{
if (widget.getBounds().contains(mousePosition.getX(), mousePosition.getY()))
{
ItemComposition itemComposition = itemManager.getItemComposition(widget.getItemId());
search(itemComposition);
return true;
}
}
return false;
}
/**
* Finds the item clicked based on the mouse location
* @param items
* @return true if an item is found, false otherwise
*/
private boolean findAndSearch(WidgetItem[] items)
{
Point mousePosition = client.getMouseCanvasPosition();
for (WidgetItem item : items)
{
if (item.getCanvasBounds().contains(mousePosition.getX(), mousePosition.getY()))
{
ItemComposition itemComposition = itemManager.getItemComposition(item.getId());
search(itemComposition);
return true;
}
}
return false;
}
private void search(ItemComposition itemComposition)
{
SwingUtilities.invokeLater(() ->
{
panel.showSearch();
if (!button.isSelected())
{
button.getOnSelect().run();
}
panel.getSearchPanel().priceLookup(itemComposition.getName());
});
}
};
if (config.quickLookup()) if (config.quickLookup())
{ {
mouseManager.registerMouseListener(itemClick); mouseManager.registerMouseListener(inputListener);
keyManager.registerKeyListener(inputListener);
} }
} }
@@ -210,7 +129,8 @@ public class GrandExchangePlugin extends Plugin
protected void shutDown() protected void shutDown()
{ {
pluginToolbar.removeNavigation(button); pluginToolbar.removeNavigation(button);
mouseManager.unregisterMouseListener(itemClick); mouseManager.unregisterMouseListener(inputListener);
keyManager.unregisterKeyListener(inputListener);
} }
@Subscribe @Subscribe
@@ -222,11 +142,13 @@ public class GrandExchangePlugin extends Plugin
{ {
if (config.quickLookup()) if (config.quickLookup())
{ {
mouseManager.registerMouseListener(itemClick); mouseManager.registerMouseListener(inputListener);
keyManager.registerKeyListener(inputListener);
} }
else else
{ {
mouseManager.unregisterMouseListener(itemClick); mouseManager.unregisterMouseListener(inputListener);
keyManager.unregisterKeyListener(inputListener);
} }
} }
} }
@@ -241,4 +163,44 @@ public class GrandExchangePlugin extends Plugin
BufferedImage itemImage = itemManager.getImage(offer.getItemId(), offer.getTotalQuantity(), shouldStack); BufferedImage itemImage = itemManager.getImage(offer.getItemId(), offer.getTotalQuantity(), shouldStack);
SwingUtilities.invokeLater(() -> panel.updateOffer(offerItem, itemImage, offerEvent.getOffer(), offerEvent.getSlot())); SwingUtilities.invokeLater(() -> panel.updateOffer(offerItem, itemImage, offerEvent.getOffer(), offerEvent.getSlot()));
} }
@Subscribe
public void onMenuEntryAdded(MenuEntryAdded event)
{
// At the moment, if the user disables quick lookup, the input listener gets disabled. Thus, isHotKeyPressed()
// should always return false when quick lookup is disabled.
// Replace the default option with "Search ..." when holding alt
if (client.getGameState() != GameState.LOGGED_IN || !hotKeyPressed)
{
return;
}
final MenuEntry[] entries = client.getMenuEntries();
final MenuEntry menuEntry = entries[entries.length - 1];
final int widgetId = menuEntry.getParam1();
final int groupId = WidgetInfo.TO_GROUP(widgetId);
switch (groupId)
{
case WidgetID.BANK_GROUP_ID:
// Don't show for view tabs and such
if (WidgetInfo.TO_CHILD(widgetId) != WidgetInfo.BANK_ITEM_CONTAINER.getChildId())
{
break;
}
case WidgetID.INVENTORY_GROUP_ID:
case WidgetID.BANK_INVENTORY_GROUP_ID:
menuEntry.setOption("Search Grand Exchange");
client.setMenuEntries(entries);
}
}
@Subscribe
public void onFocusChanged(FocusChanged focusChanged)
{
if (!focusChanged.isFocused())
{
setHotKeyPressed(false);
}
}
} }