bosstimers: Boss Time Tracking (#1590)

bosstimers: Boss Time Tracking
This commit is contained in:
ST0NEWALL
2019-11-06 16:29:52 -05:00
committed by GitHub
2 changed files with 384 additions and 0 deletions

View File

@@ -0,0 +1,90 @@
/*
* Copyright (c) 2019, winterdaze
* 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.bosstimetracker;
import net.runelite.client.ui.overlay.infobox.InfoBox;
import java.awt.image.BufferedImage;
import java.awt.Color;
import java.time.Duration;
import java.time.Instant;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
public class BossTimeTracker extends InfoBox
{
private final Instant startTime;
private LocalTime time;
private Instant lastTime;
public BossTimeTracker(BufferedImage image, BossTimeTrackerPlugin plugin, Instant startTime, Instant lastTime)
{
super(image, plugin);
this.startTime = startTime;
this.lastTime = lastTime;
}
@Override
public String getText()
{
if (startTime == null)
{
return "";
}
if (lastTime == null)
{
Duration elapsed = Duration.between(startTime, Instant.now());
time = LocalTime.ofSecondOfDay(elapsed.getSeconds());
}
else
{
Duration elapsed = Duration.between(startTime, lastTime);
time = LocalTime.ofSecondOfDay(elapsed.getSeconds());
}
if (time.getHour() > 0)
{
return time.format(DateTimeFormatter.ofPattern("HH:mm"));
}
return time.format(DateTimeFormatter.ofPattern("mm:ss"));
}
@Override
public Color getTextColor()
{
return Color.WHITE;
}
@Override
public String getTooltip()
{
StringBuilder builder = new StringBuilder();
builder.append("Elapsed time: ");
builder.append(time.format(DateTimeFormatter.ofPattern("HH:mm:ss")));
return builder.toString();
}
}

View File

@@ -0,0 +1,294 @@
/*
* Copyright (c) 2019, winterdaze
* 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.bosstimetracker;
import lombok.Getter;
import net.runelite.api.ChatMessageType;
import net.runelite.api.Client;
import net.runelite.api.events.ChatMessage;
import net.runelite.api.events.GameStateChanged;
import net.runelite.api.util.Text;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.game.ItemManager;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.plugins.PluginType;
import net.runelite.client.ui.overlay.infobox.InfoBoxManager;
import net.runelite.client.eventbus.EventBus;
import javax.inject.Inject;
import java.time.Duration;
import java.time.Instant;
import java.util.Arrays;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static net.runelite.api.ItemID.FIRE_CAPE;
import static net.runelite.api.ItemID.INFERNAL_CAPE;
@PluginDescriptor(
name = "Boss Time Tracker",
description = "Display elapsed time in the Fight Caves and Inferno",
tags = {"inferno", "fight", "caves", "cape", "timer", "tzhaar", "pvm"},
type = PluginType.PVM,
enabledByDefault = false
)
public class BossTimeTrackerPlugin extends Plugin
{
private static final Pattern WAVE_MESSAGE = Pattern.compile("Wave: (\\d+)");
private static final String DEFEATED_MESSAGE = "You have been defeated!";
private static final Pattern COMPLETE_MESSAGE = Pattern.compile("Your (TzTok-Jad|TzKal-Zuk) kill count is:");
private static final Pattern PAUSED_MESSAGE = Pattern.compile("The (Inferno|Fight Cave) has been paused. You may now log out.");
private static final String CONFIG_GROUP = "Boss Time Tracker";
private static final String CONFIG_TIME = "time";
private static final String CONFIG_STARTED = "started";
private static final String CONFIG_LASTTIME = "lasttime";
@Inject
private InfoBoxManager infoBoxManager;
@Inject
private Client client;
@Inject
private ItemManager itemManager;
@Inject
private ConfigManager configManager;
@Inject
private EventBus eventBus;
@Getter
private BossTimeTracker timer;
private Instant startTime;
private Instant lastTime;
private Boolean started = false;
private boolean loggingIn;
@Override
public void startUp()
{
addSubscriptions();
}
public void onGameStateChanged(GameStateChanged event)
{
switch (event.getGameState())
{
case LOGGED_IN:
if (loggingIn)
{
loggingIn = false;
loadConfig();
resetConfig();
}
break;
case LOGGING_IN:
loggingIn = true;
break;
case LOADING:
if (!loggingIn)
{
updateInfoBoxState();
}
break;
case HOPPING:
loggingIn = true;
case LOGIN_SCREEN:
removeTimer();
saveConfig();
break;
default:
break;
}
}
public void onChatMessage(ChatMessage event)
{
if (event.getType() != ChatMessageType.GAMEMESSAGE && event.getType() != ChatMessageType.SPAM)
{
return;
}
String message = Text.removeTags(event.getMessage());
Matcher matcher = COMPLETE_MESSAGE.matcher(message);
if (message.contains(DEFEATED_MESSAGE) || matcher.matches())
{
removeTimer();
resetConfig();
resetVars();
return;
}
Instant now = Instant.now();
matcher = PAUSED_MESSAGE.matcher(message);
if (matcher.matches())
{
lastTime = now;
createTimer(startTime, now);
return;
}
matcher = WAVE_MESSAGE.matcher(message);
if (!matcher.matches())
{
return;
}
if (!started)
{
int wave = Integer.parseInt(matcher.group(1));
if (wave != 1)
{
return;
}
started = true;
startTime = now;
}
else if (lastTime != null)
{
startTime = startTime.plus(Duration.between(startTime, now)).minus(Duration.between(startTime, lastTime));
lastTime = null;
}
createTimer(startTime, lastTime);
}
private void updateInfoBoxState()
{
if (timer == null)
{
return;
}
if (!checkInFightCaves() && !checkInInferno())
{
removeTimer();
resetConfig();
resetVars();
}
}
private boolean checkInFightCaves()
{
return client.getMapRegions() != null && Arrays.stream(client.getMapRegions())
.filter(x -> x == 9551)
.toArray().length > 0;
}
private boolean checkInInferno()
{
return client.getMapRegions() != null && Arrays.stream(client.getMapRegions())
.filter(x -> x == 9043)
.toArray().length > 0;
}
private void resetVars()
{
startTime = null;
lastTime = null;
started = false;
}
private void removeTimer()
{
infoBoxManager.removeInfoBox(timer);
timer = null;
}
private void createTimer(Instant startTime, Instant lastTime)
{
if (timer != null)
{
infoBoxManager.removeInfoBox(timer);
}
if (checkInFightCaves())
{
timer = new BossTimeTracker(itemManager.getImage(FIRE_CAPE), this, startTime, lastTime);
infoBoxManager.addInfoBox(timer);
}
else if (checkInInferno())
{
timer = new BossTimeTracker(itemManager.getImage(INFERNAL_CAPE), this, startTime, lastTime);
infoBoxManager.addInfoBox(timer);
}
}
@Override
protected void shutDown() throws Exception
{
eventBus.unregister(this);
removeTimer();
resetConfig();
resetVars();
}
private void addSubscriptions()
{
eventBus.subscribe(GameStateChanged.class, this, this::onGameStateChanged);
eventBus.subscribe(ChatMessage.class, this, this::onChatMessage);
}
private void loadConfig()
{
startTime = configManager.getConfiguration(CONFIG_GROUP, CONFIG_TIME, Instant.class);
started = configManager.getConfiguration(CONFIG_GROUP, CONFIG_STARTED, Boolean.class);
lastTime = configManager.getConfiguration(CONFIG_GROUP, CONFIG_LASTTIME, Instant.class);
if (started == null)
{
started = false;
}
}
private void resetConfig()
{
configManager.unsetConfiguration(CONFIG_GROUP, CONFIG_TIME);
configManager.unsetConfiguration(CONFIG_GROUP, CONFIG_STARTED);
configManager.unsetConfiguration(CONFIG_GROUP, CONFIG_LASTTIME);
}
private void saveConfig()
{
if (startTime == null)
{
return;
}
if (lastTime == null)
{
lastTime = Instant.now();
}
configManager.setConfiguration(CONFIG_GROUP, CONFIG_TIME, startTime);
configManager.setConfiguration(CONFIG_GROUP, CONFIG_STARTED, started);
configManager.setConfiguration(CONFIG_GROUP, CONFIG_LASTTIME, lastTime);
resetVars();
}
}