Merge pull request runelite#284 from Unmoon/xp-tracker-reset-toggle

XP tracker plugin - Allow hopping/logging out/other GameState changes, Fix login experience drop not being ignored

runelite-api/src/main/java/net/runelite/api/Client.java

@@ -62,6 +62,8 @@ public interface Client extends GameEngine
 
 	int getCameraYaw();
 
+	int getWorld();
+
 	int getViewportHeight();
 
 	int getViewportWidth();

runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpTrackerPlugin.java

@@ -25,22 +25,34 @@
 package net.runelite.client.plugins.xptracker;
 
 import com.google.common.eventbus.Subscribe;
+import java.io.IOException;
+import java.time.temporal.ChronoUnit;
+import java.util.Arrays;
+import java.util.EnumSet;
+import java.util.Objects;
 import javax.imageio.ImageIO;
+import javax.inject.Inject;
+import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.Client;
+import net.runelite.api.GameState;
 import net.runelite.api.Skill;
 import net.runelite.api.events.ExperienceChanged;
 import net.runelite.api.events.GameStateChanged;
 import net.runelite.client.plugins.Plugin;
-import net.runelite.client.ui.ClientUI;
-import net.runelite.client.ui.NavigationButton;
-import java.time.temporal.ChronoUnit;
-import javax.inject.Inject;
 import net.runelite.client.plugins.PluginDescriptor;
+import static net.runelite.client.plugins.xptracker.XpWorldType.NORMAL;
 import net.runelite.client.task.Schedule;
+import net.runelite.client.ui.ClientUI;
+import net.runelite.client.ui.NavigationButton;
+import net.runelite.http.api.worlds.World;
+import net.runelite.http.api.worlds.WorldClient;
+import net.runelite.http.api.worlds.WorldResult;
+import net.runelite.http.api.worlds.WorldType;
 
 @PluginDescriptor(
 	name = "XP tracker plugin"
 )
+@Slf4j
 public class XpTrackerPlugin extends Plugin
 {
 	private static final int NUMBER_OF_SKILLS = Skill.values().length - 1; //ignore overall
@@ -54,10 +66,25 @@ public class XpTrackerPlugin extends Plugin
 	private NavigationButton navButton;
 	private XpPanel xpPanel;
 	private final SkillXPInfo[] xpInfos = new SkillXPInfo[NUMBER_OF_SKILLS];
+	private WorldResult worlds;
+
+	private XpWorldType lastWorldType;
+	private String lastUsername;
 
 	@Override
 	protected void startUp() throws Exception
 	{
+		WorldClient worldClient = new WorldClient();
+		try
+		{
+			worlds = worldClient.lookupWorlds();
+			log.debug("Worlds list contains {} worlds", worlds.getWorlds().size());
+		}
+		catch (IOException e)
+		{
+			log.warn("Error looking up worlds list", e);
+		}
+
 		xpPanel = injector.getInstance(XpPanel.class);
 		navButton = new NavigationButton(
 			"XP Tracker",
@@ -76,13 +103,47 @@ protected void shutDown() throws Exception
 	@Subscribe
 	public void onGameStateChanged(GameStateChanged event)
 	{
-		// reset on world hop or logging in
-		switch (event.getGameState())
+		if (event.getGameState() == GameState.LOGGED_IN)
 		{
-			case HOPPING:
-			case LOGGING_IN:
+			// LOGGED_IN is triggered between region changes too.
+			// Check that the username changed or the world type changed.
+			World world = worlds.findWorld(client.getWorld());
+
+			if (world == null)
+			{
+				log.warn("Logged into nonexistent world {}?", client.getWorld());
+				return;
+			}
+
+			XpWorldType type = worldSetToType(world.getTypes());
+
+			if (!Objects.equals(client.getUsername(), lastUsername) || lastWorldType != type)
+			{
+				// Reset
+				log.debug("World change: {} -> {}, {} -> {}",
+					lastUsername, client.getUsername(), lastWorldType, type);
+
+				lastUsername = client.getUsername();
+				lastWorldType = type;
+
 				xpPanel.resetAllSkillXpHr();
+				Arrays.fill(xpInfos, null);
+			}
+		}
+	}
+
+	private XpWorldType worldSetToType(EnumSet<WorldType> types)
+	{
+		XpWorldType xpType = NORMAL;
+		for (WorldType type : types)
+		{
+			XpWorldType t = XpWorldType.of(type);
+			if (t != NORMAL)
+			{
+				xpType = t;
+			}
 		}
+		return xpType;
 	}
 
 	@Subscribe

runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpWorldType.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2018, Adam <[email protected]>
+ * 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.xptracker;
+
+import net.runelite.http.api.worlds.WorldType;
+
+enum XpWorldType
+{
+	NORMAL,
+	DMM,
+	SDMM;
+
+	public static XpWorldType of(WorldType type)
+	{
+		switch (type)
+		{
+			case DEADMAN:
+				return DMM;
+			case SEASONAL_DEADMAN:
+				return SDMM;
+			default:
+				return NORMAL;
+		}
+	}
+}