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

Add tile indicators plugin

Browse Source 
Add tile indicators plugin, that will currently highlight the tile
player is walking to. It is disabled by default, and have configurable
highlighting color.

Signed-off-by: Tomas Slusny <slusnucky@gmail.com>
This commit is contained in:
Tomas Slusny
2018-01-09 23:33:10 +01:00
parent facff8fe2f
commit f565c4b7dd
6 changed files with 214 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
runelite-api/src/main/java/net/runelite/api/Client.java
View File

@@ -167,4 +167,6 @@ public interface Client
boolean isIgnored(String name);
boolean isClanMember(String name);
Point getSceneDestinationLocation();
}

58
runelite-client/src/main/java/net/runelite/client/plugins/tileindicators/TileIndicatorsConfig.java Normal file
View File

@@ -0,0 +1,58 @@
/*
* Copyright (c) 2018, Tomas Slusny <slusnucky@gmail.com>
* 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.tileindicators;
import java.awt.Color;
import net.runelite.client.config.Config;
import net.runelite.client.config.ConfigGroup;
import net.runelite.client.config.ConfigItem;
@ConfigGroup(
keyName = "tileindicators",
name = "Tile Indicators",
description = "Configuration for the tile indicators plugin"
)
public interface TileIndicatorsConfig extends Config
{
@ConfigItem(
keyName = "highlightDestination",
name = "Highlight current destination (walk-to) tile",
description = "Configures whether or not current destination tile is highlighted"
)
default boolean highlightDestination()
{
return false;
}
@ConfigItem(
keyName = "highlightDestinationColor",
name = "Color of current destination highlighting",
description = "Configures the highlight color of current destination"
)
default Color highlightDestinationColor()
{
return Color.GRAY;
}
}

76
runelite-client/src/main/java/net/runelite/client/plugins/tileindicators/TileIndicatorsOverlay.java Normal file
View File

@@ -0,0 +1,76 @@
/*
* Copyright (c) 2018, Tomas Slusny <slusnucky@gmail.com>
* 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.tileindicators;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Polygon;
import net.runelite.api.Client;
import net.runelite.api.Perspective;
import net.runelite.api.Point;
import net.runelite.client.ui.overlay.Overlay;
import net.runelite.client.ui.overlay.OverlayPosition;
import net.runelite.client.ui.overlay.OverlayPriority;
import net.runelite.client.ui.overlay.OverlayUtil;
public class TileIndicatorsOverlay extends Overlay
{
private final Client client;
private final TileIndicatorsConfig config;
TileIndicatorsOverlay(Client client, TileIndicatorsConfig config)
{
this.client = client;
this.config = config;
setPosition(OverlayPosition.DYNAMIC);
setPriority(OverlayPriority.LOW);
}
@Override
public Dimension render(Graphics2D graphics, java.awt.Point parent)
{
if (config.highlightDestination()
&& client.getSceneDestinationLocation().getX() >= 0
&& client.getSceneDestinationLocation().getY() >= 0)
{
drawRegionTile(graphics, client.getSceneDestinationLocation(), config.highlightDestinationColor());
}
return null;
}
private void drawRegionTile(Graphics2D graphics, Point tile, Color color)
{
Point localTile = Perspective.regionToLocal(client, tile);
localTile = new Point(localTile.getX() + Perspective.LOCAL_TILE_SIZE / 2, localTile.getY() + Perspective.LOCAL_TILE_SIZE / 2);
Polygon poly = Perspective.getCanvasTilePoly(client, localTile);
if (poly != null)
{
OverlayUtil.renderPolygon(graphics, poly, color);
}
}
}

65
runelite-client/src/main/java/net/runelite/client/plugins/tileindicators/TileIndicatorsPlugin.java Normal file
View File

@@ -0,0 +1,65 @@
/*
* Copyright (c) 2018, Tomas Slusny <slusnucky@gmail.com>
* 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.tileindicators;
import com.google.inject.Provides;
import javax.inject.Inject;
import net.runelite.api.Client;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.ui.overlay.Overlay;
@PluginDescriptor(
name = "Tile Indicators plugin"
)
public class TileIndicatorsPlugin extends Plugin
{
@Inject
Client client;
@Inject
TileIndicatorsConfig config;
private TileIndicatorsOverlay tileIndicatorsOverlay;
@Provides
TileIndicatorsConfig provideConfig(ConfigManager configManager)
{
return configManager.getConfig(TileIndicatorsConfig.class);
}
@Override
protected void startUp() throws Exception
{
tileIndicatorsOverlay = new TileIndicatorsOverlay(client, config);
}
@Override
public Overlay getOverlay()
{
return tileIndicatorsOverlay;
}
}

7
runelite-mixins/src/main/java/net/runelite/mixins/RSClientMixin.java
View File

@@ -338,6 +338,13 @@ public abstract class RSClientMixin implements RSClient
setRSModIcons((RSIndexedSprite[]) modIcons);
}
@Inject
@Override
public Point getSceneDestinationLocation()
{
return new Point(getDestinationX(), getDestinationY());
}
@FieldHook("skillExperiences")
@Inject
public static void experiencedChanged(int idx)

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

@@ -332,4 +332,10 @@ public interface RSClient extends RSGameEngine, Client
@Construct
@Override
RSIndexedSprite createIndexedSprite();
@Import("destinationX")
int getDestinationX();
@Import("destinationY")
int getDestinationY();
}