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

client: remove death indicator plugin

Browse Source 
The gane update tomorrow will contain a timer & map waypoint
This commit is contained in:
Adam
2020-06-24 16:20:29 -04:00
parent c5a698f852
commit 86ddd6ebd4
3 changed files with 0 additions and 609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

155
runelite-client/src/main/java/net/runelite/client/plugins/deathindicator/DeathIndicatorConfig.java
View File

@@ -1,155 +0,0 @@
/*
* Copyright (c) 2018, Danny <DannysPVM@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.deathindicator;
import java.time.Instant;
import net.runelite.client.config.Config;
import net.runelite.client.config.ConfigGroup;
import net.runelite.client.config.ConfigItem;
@ConfigGroup("deathIndicator")
public interface DeathIndicatorConfig extends Config
{
@ConfigItem(
position = 1,
keyName = "deathHintArrow",
name = "Death Hint Arrow",
description = "Configures whether or not to show a hint arrow to death location"
)
default boolean showDeathHintArrow()
{
return true;
}
@ConfigItem(
position = 2,
keyName = "deathInfoBox",
name = "Death InfoBox",
description = "Configures whether or not to show item reclaim timer and death world infobox"
)
default boolean showDeathInfoBox()
{
return true;
}
@ConfigItem(
position = 3,
keyName = "deathOnWorldMap",
name = "Mark on World Map",
description = "Configures whether or not to show death location on the world map"
)
default boolean showDeathOnWorldMap()
{
return true;
}
// Stored Data
@ConfigItem(
keyName = "deathWorld",
name = "",
description = "",
hidden = true
)
default int deathWorld()
{
return -1;
}
@ConfigItem(
keyName = "deathWorld",
name = "",
description = ""
)
void deathWorld(int deathWorld);
@ConfigItem(
keyName = "deathLocationX",
name = "",
description = "",
hidden = true
)
default int deathLocationX()
{
return -1;
}
@ConfigItem(
keyName = "deathLocationX",
name = "",
description = ""
)
void deathLocationX(int deathLocationX);
@ConfigItem(
keyName = "deathLocationY",
name = "",
description = "",
hidden = true
)
default int deathLocationY()
{
return -1;
}
@ConfigItem(
keyName = "deathLocationY",
name = "",
description = ""
)
void deathLocationY(int deathLocationY);
@ConfigItem(
keyName = "deathLocationPlane",
name = "",
description = "",
hidden = true
)
default int deathLocationPlane()
{
return -1;
}
@ConfigItem(
keyName = "deathLocationPlane",
name = "",
description = ""
)
void deathLocationPlane(int deathLocationPlane);
@ConfigItem(
keyName = "timeOfDeath",
name = "",
description = "",
hidden = true
)
Instant timeOfDeath();
@ConfigItem(
keyName = "timeOfDeath",
name = "",
description = ""
)
void timeOfDeath(Instant timeOfDeath);
}

380
runelite-client/src/main/java/net/runelite/client/plugins/deathindicator/DeathIndicatorPlugin.java
View File

@@ -1,380 +0,0 @@
/*
* Copyright (c) 2018, Danny <DannysPVM@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.deathindicator;
import com.google.common.collect.ImmutableSet;
import com.google.inject.Provides;
import java.awt.image.BufferedImage;
import java.time.Duration;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Set;
import javax.inject.Inject;
import javax.inject.Named;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.GameState;
import net.runelite.api.ItemID;
import net.runelite.api.MenuAction;
import net.runelite.api.coords.WorldPoint;
import net.runelite.api.events.CommandExecuted;
import net.runelite.api.events.GameStateChanged;
import net.runelite.api.events.GameTick;
import net.runelite.api.events.PlayerDeath;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.events.ConfigChanged;
import net.runelite.client.events.InfoBoxMenuClicked;
import net.runelite.client.game.ItemManager;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.ui.overlay.OverlayMenuEntry;
import net.runelite.client.ui.overlay.infobox.InfoBoxManager;
import net.runelite.client.ui.overlay.infobox.Timer;
import net.runelite.client.ui.overlay.worldmap.WorldMapPointManager;
import net.runelite.client.util.ImageUtil;
@PluginDescriptor(
name = "Death Indicator",
description = "Show where you last died, and on what world",
tags = {"arrow", "hints", "world", "map", "overlay"}
)
@Slf4j
public class DeathIndicatorPlugin extends Plugin
{
private static final String DEATH_TIMER_CLEAR = "Clear";
private static final Set<Integer> RESPAWN_REGIONS = ImmutableSet.of(
6457, // Kourend
12850, // Lumbridge
11828, // Falador
12342, // Edgeville
11062, // Camelot
13150, // Prifddinas (it's possible to spawn in 2 adjacent regions)
12894 // Prifddinas
);
@Inject
private Client client;
@Inject
private DeathIndicatorConfig config;
@Inject
private WorldMapPointManager worldMapPointManager;
@Inject
private InfoBoxManager infoBoxManager;
@Inject
private ItemManager itemManager;
@Inject
@Named("developerMode")
boolean developerMode;
private BufferedImage mapArrow;
private Timer deathTimer;
private WorldPoint lastDeath;
private Instant lastDeathTime;
private int lastDeathWorld;
@Provides
DeathIndicatorConfig deathIndicatorConfig(ConfigManager configManager)
{
return configManager.getConfig(DeathIndicatorConfig.class);
}
@Override
protected void startUp()
{
if (!hasDied())
{
return;
}
resetInfobox();
if (client.getWorld() != config.deathWorld())
{
return;
}
if (config.showDeathHintArrow())
{
if (!client.hasHintArrow())
{
client.setHintArrow(new WorldPoint(config.deathLocationX(), config.deathLocationY(), config.deathLocationPlane()));
}
}
if (config.showDeathOnWorldMap())
{
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
worldMapPointManager.add(new DeathWorldMapPoint(new WorldPoint(config.deathLocationX(), config.deathLocationY(), config.deathLocationPlane()), this));
}
}
@Override
protected void shutDown()
{
if (client.hasHintArrow())
{
client.clearHintArrow();
}
if (deathTimer != null)
{
infoBoxManager.removeInfoBox(deathTimer);
deathTimer = null;
}
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
}
@Subscribe
public void onPlayerDeath(PlayerDeath playerDeath)
{
if (client.isInInstancedRegion() || playerDeath.getPlayer() != client.getLocalPlayer())
{
return;
}
lastDeath = client.getLocalPlayer().getWorldLocation();
lastDeathWorld = client.getWorld();
lastDeathTime = Instant.now();
}
@Subscribe
public void onGameTick(GameTick event)
{
// Check if player respawned in a death respawn location
if (lastDeath != null && !client.getLocalPlayer().getWorldLocation().equals(lastDeath))
{
if (!RESPAWN_REGIONS.contains(client.getLocalPlayer().getWorldLocation().getRegionID()))
{
log.debug("Died, but did not respawn in a known respawn location: {}",
client.getLocalPlayer().getWorldLocation().getRegionID());
lastDeath = null;
lastDeathTime = null;
return;
}
log.debug("Died! Grave at {}", lastDeath);
die(lastDeath, lastDeathTime, lastDeathWorld);
lastDeath = null;
lastDeathTime = null;
}
if (!hasDied() || client.getWorld() != config.deathWorld())
{
return;
}
// Check if the player is at their death location, or timer has passed
WorldPoint deathPoint = new WorldPoint(config.deathLocationX(), config.deathLocationY(), config.deathLocationPlane());
if (deathPoint.equals(client.getLocalPlayer().getWorldLocation()) || (deathTimer != null && deathTimer.cull()))
{
reset();
resetDeathConfig();
}
}
@Subscribe
public void onCommandExecuted(CommandExecuted commandExecuted)
{
if (developerMode && commandExecuted.getCommand().equals("die"))
{
die(client.getLocalPlayer().getWorldLocation(), Instant.now(), client.getWorld());
}
}
private void die(WorldPoint location, Instant time, int world)
{
// Save death to config
config.deathLocationX(location.getX());
config.deathLocationY(location.getY());
config.deathLocationPlane(location.getPlane());
config.timeOfDeath(time);
config.deathWorld(world);
if (config.showDeathHintArrow())
{
client.setHintArrow(location);
}
if (config.showDeathOnWorldMap())
{
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
worldMapPointManager.add(new DeathWorldMapPoint(location, this));
}
resetInfobox();
}
@Subscribe
public void onConfigChanged(ConfigChanged event)
{
if (event.getGroup().equals("deathIndicator"))
{
if (!config.showDeathHintArrow() && hasDied())
{
client.clearHintArrow();
}
if (!config.showDeathInfoBox() && deathTimer != null)
{
infoBoxManager.removeInfoBox(deathTimer);
deathTimer = null;
}
if (!config.showDeathOnWorldMap())
{
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
}
if (!hasDied())
{
client.clearHintArrow();
resetInfobox();
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
}
}
}
@Subscribe
public void onGameStateChanged(GameStateChanged event)
{
if (!hasDied())
{
return;
}
if (event.getGameState() == GameState.LOGGED_IN)
{
if (client.getWorld() == config.deathWorld())
{
WorldPoint deathPoint = new WorldPoint(config.deathLocationX(), config.deathLocationY(), config.deathLocationPlane());
if (config.showDeathHintArrow())
{
client.setHintArrow(deathPoint);
}
if (config.showDeathOnWorldMap())
{
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
worldMapPointManager.add(new DeathWorldMapPoint(deathPoint, this));
}
}
else
{
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
}
}
}
@Subscribe
public void onInfoBoxMenuClicked(InfoBoxMenuClicked infoBoxMenuClicked)
{
if (infoBoxMenuClicked.getInfoBox() == deathTimer)
{
reset();
}
}
private boolean hasDied()
{
return config.timeOfDeath() != null;
}
private void reset()
{
client.clearHintArrow();
if (deathTimer != null)
{
infoBoxManager.removeInfoBox(deathTimer);
deathTimer = null;
}
worldMapPointManager.removeIf(DeathWorldMapPoint.class::isInstance);
}
private void resetDeathConfig()
{
config.deathLocationX(0);
config.deathLocationY(0);
config.deathLocationPlane(0);
config.deathWorld(0);
config.timeOfDeath(null);
}
private void resetInfobox()
{
if (deathTimer != null)
{
infoBoxManager.removeInfoBox(deathTimer);
deathTimer = null;
}
if (hasDied() && config.showDeathInfoBox())
{
Instant now = Instant.now();
Duration timeLeft = Duration.ofHours(1).minus(Duration.between(config.timeOfDeath(), now));
if (!timeLeft.isNegative() && !timeLeft.isZero())
{
deathTimer = new Timer(timeLeft.getSeconds(), ChronoUnit.SECONDS, getBonesImage(), this);
deathTimer.setTooltip("Died on world: " + config.deathWorld());
deathTimer.getMenuEntries().add(new OverlayMenuEntry(MenuAction.RUNELITE_INFOBOX, DEATH_TIMER_CLEAR, "Death Timer"));
infoBoxManager.addInfoBox(deathTimer);
}
}
}
BufferedImage getMapArrow()
{
if (mapArrow != null)
{
return mapArrow;
}
mapArrow = ImageUtil.getResourceStreamFromClass(getClass(), "/util/clue_arrow.png");
return mapArrow;
}
BufferedImage getBonesImage()
{
return itemManager.getImage(ItemID.BONES);
}
}

74
runelite-client/src/main/java/net/runelite/client/plugins/deathindicator/DeathWorldMapPoint.java
View File

@@ -1,74 +0,0 @@
/*
* Copyright (c) 2018, Danny <DannysPVM@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.deathindicator;
import java.awt.Graphics;
import java.awt.image.BufferedImage;
import net.runelite.api.Point;
import net.runelite.api.coords.WorldPoint;
import net.runelite.client.ui.overlay.worldmap.WorldMapPoint;
class DeathWorldMapPoint extends WorldMapPoint
{
private final DeathIndicatorPlugin plugin;
private final BufferedImage worldmapHintArrow;
private final Point worldmapHintArrowPoint;
DeathWorldMapPoint(final WorldPoint worldPoint, final DeathIndicatorPlugin plugin)
{
super(worldPoint, null);
worldmapHintArrow = new BufferedImage(plugin.getMapArrow().getWidth(), plugin.getMapArrow().getHeight(), BufferedImage.TYPE_INT_ARGB);
Graphics graphics = worldmapHintArrow.getGraphics();
graphics.drawImage(plugin.getMapArrow(), 0, 0, null);
graphics.drawImage(plugin.getBonesImage(), 0, 0, null);
worldmapHintArrowPoint = new Point(
worldmapHintArrow.getWidth() / 2,
worldmapHintArrow.getHeight());
this.plugin = plugin;
this.setSnapToEdge(true);
this.setJumpOnClick(true);
this.setImage(worldmapHintArrow);
this.setImagePoint(worldmapHintArrowPoint);
this.setTooltip("Death Location");
}
@Override
public void onEdgeSnap()
{
this.setImage(plugin.getBonesImage());
this.setImagePoint(null);
this.setTooltip(null);
}
@Override
public void onEdgeUnsnap()
{
this.setImage(worldmapHintArrow);
this.setImagePoint(worldmapHintArrowPoint);
this.setTooltip("Death Location");
}
}