Merge pull request #8049 from ShaunDreclin/music-track-indicator

Add Music Track Indicator plugin

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

@@ -26,6 +26,8 @@ package net.runelite.api;
 
 public interface EnumComposition
 {
+	int[] getKeys();
+
 	int[] getIntVals();
 
 	String[] getStringVals();

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

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2019, Shaun Dreclin <https://github.com/ShaunDreclin>
+ * 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.api;
+
+/**
+ * Utility class used for mapping enum IDs.
+ * <p>
+ * Note: This class is not complete and may be missing mapped IDs.
+ */
+public final class EnumID
+{
+	public static final int MUSIC_TRACK_NAMES = 812;
+	public static final int MUSIC_TRACK_IDS = 819;
+}

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

@@ -134,7 +134,30 @@ public enum VarPlayer
 	 * Slayer unlock bitfields
 	 */
 	SLAYER_UNLOCK_1(1076),
-	SLAYER_UNLOCK_2(1344);
+	SLAYER_UNLOCK_2(1344),
+
+	/**
+	 * Music track unlock bitfields
+	 */
+	MUSIC_TRACKS_UNLOCKED_1(20),
+	MUSIC_TRACKS_UNLOCKED_2(21),
+	MUSIC_TRACKS_UNLOCKED_3(22),
+	MUSIC_TRACKS_UNLOCKED_4(23),
+	MUSIC_TRACKS_UNLOCKED_5(24),
+	MUSIC_TRACKS_UNLOCKED_6(25),
+	MUSIC_TRACKS_UNLOCKED_7(298),
+	MUSIC_TRACKS_UNLOCKED_8(311),
+	MUSIC_TRACKS_UNLOCKED_9(346),
+	MUSIC_TRACKS_UNLOCKED_10(414),
+	MUSIC_TRACKS_UNLOCKED_11(464),
+	MUSIC_TRACKS_UNLOCKED_12(598),
+	MUSIC_TRACKS_UNLOCKED_13(662),
+	MUSIC_TRACKS_UNLOCKED_14(721),
+	MUSIC_TRACKS_UNLOCKED_15(906),
+	MUSIC_TRACKS_UNLOCKED_16(1009),
+	MUSIC_TRACKS_UNLOCKED_17(1338),
+	MUSIC_TRACKS_UNLOCKED_18(1681),
+	MUSIC_TRACKS_UNLOCKED_19(2065);
 
 	private final int id;
 }

runelite-client/src/main/java/net/runelite/client/plugins/musicindicator/MusicIndicatorPlugin.java

@@ -0,0 +1,204 @@
+/*
+ * Copyright (c) 2019, Shaun Dreclin <https://github.com/ShaunDreclin>
+ * 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.musicindicator;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+import javax.inject.Inject;
+import net.runelite.api.ChatMessageType;
+import net.runelite.api.Client;
+import net.runelite.api.EnumComposition;
+import net.runelite.api.EnumID;
+import net.runelite.api.VarPlayer;
+import net.runelite.api.events.GameStateChanged;
+import net.runelite.api.events.GameTick;
+import net.runelite.api.events.VarbitChanged;
+import net.runelite.client.chat.ChatColorType;
+import net.runelite.client.chat.ChatMessageBuilder;
+import net.runelite.client.chat.ChatMessageManager;
+import net.runelite.client.chat.QueuedMessage;
+import net.runelite.client.eventbus.Subscribe;
+import net.runelite.client.plugins.Plugin;
+import net.runelite.client.plugins.PluginDescriptor;
+
+@PluginDescriptor(
+	name = "Music Track Indicator",
+	description = "Show chat notifications when unlocking music tracks"
+)
+public class MusicIndicatorPlugin extends Plugin
+{
+	private static final List<VarPlayer> MUSIC_TRACK_VARPS = ImmutableList.of(
+		VarPlayer.MUSIC_TRACKS_UNLOCKED_1, VarPlayer.MUSIC_TRACKS_UNLOCKED_2, VarPlayer.MUSIC_TRACKS_UNLOCKED_3,
+		VarPlayer.MUSIC_TRACKS_UNLOCKED_4, VarPlayer.MUSIC_TRACKS_UNLOCKED_5, VarPlayer.MUSIC_TRACKS_UNLOCKED_6,
+		VarPlayer.MUSIC_TRACKS_UNLOCKED_7, VarPlayer.MUSIC_TRACKS_UNLOCKED_8, VarPlayer.MUSIC_TRACKS_UNLOCKED_9,
+		VarPlayer.MUSIC_TRACKS_UNLOCKED_10, VarPlayer.MUSIC_TRACKS_UNLOCKED_11, VarPlayer.MUSIC_TRACKS_UNLOCKED_12,
+		VarPlayer.MUSIC_TRACKS_UNLOCKED_13, VarPlayer.MUSIC_TRACKS_UNLOCKED_14, VarPlayer.MUSIC_TRACKS_UNLOCKED_15,
+		VarPlayer.MUSIC_TRACKS_UNLOCKED_16, VarPlayer.MUSIC_TRACKS_UNLOCKED_17, VarPlayer.MUSIC_TRACKS_UNLOCKED_18,
+		VarPlayer.MUSIC_TRACKS_UNLOCKED_19
+	);
+
+	private static final Map<Integer, VarPlayer> VARP_INDEX_TO_VARPLAYER = MUSIC_TRACK_VARPS.stream()
+		.collect(Collectors.collectingAndThen(Collectors.toMap(VarPlayer::getId, Function.identity()),
+			ImmutableMap::copyOf));
+
+	@Inject
+	private Client client;
+
+	@Inject
+	private ChatMessageManager chatMessageManager;
+
+	// Mapping of relevant varps to their values, used to compare against new values
+	private final Map<VarPlayer, Integer> musicTrackVarpValues = new HashMap<>();
+
+	private boolean loggingIn;
+
+	@Override
+	public void startUp()
+	{
+		loggingIn = true;
+	}
+
+	@Override
+	public void shutDown()
+	{
+		musicTrackVarpValues.clear();
+	}
+
+	@Subscribe
+	public void onGameStateChanged(GameStateChanged event)
+	{
+		switch (event.getGameState())
+		{
+			case LOGGING_IN:
+			case CONNECTION_LOST:
+			case HOPPING:
+				musicTrackVarpValues.clear();
+				loggingIn = true;
+		}
+	}
+
+	@Subscribe
+	public void onGameTick(GameTick event)
+	{
+		if (!loggingIn)
+		{
+			return;
+		}
+
+		loggingIn = false;
+
+		for (VarPlayer musicTrackVarp : MUSIC_TRACK_VARPS)
+		{
+			int value = client.getVar(musicTrackVarp);
+			musicTrackVarpValues.put(musicTrackVarp, value);
+		}
+	}
+
+	@Subscribe
+	public void onVarbitChanged(VarbitChanged event)
+	{
+		int idx = event.getIndex();
+
+		VarPlayer varPlayer = VARP_INDEX_TO_VARPLAYER.get(idx);
+		if (varPlayer == null)
+		{
+			return;
+		}
+
+		// Old varplayer values have not been initialized yet
+		if (musicTrackVarpValues.isEmpty())
+		{
+			return;
+		}
+
+		assert musicTrackVarpValues.containsKey(varPlayer);
+
+		int newValue = client.getVar(varPlayer);
+		int oldValue = musicTrackVarpValues.put(varPlayer, newValue);
+		int musicTracksUnlocked = ~oldValue & newValue;
+
+		if (musicTracksUnlocked == 0)
+		{
+			return;
+		}
+
+		final EnumComposition names = client.getEnum(EnumID.MUSIC_TRACK_NAMES);
+		final int varpId = MUSIC_TRACK_VARPS.indexOf(varPlayer) + 1;
+
+		for (int bit = 0; bit < Integer.SIZE; ++bit)
+		{
+			if ((musicTracksUnlocked & (1 << bit)) == 0)
+			{
+				continue;
+			}
+
+			int musicTrackId = getTrackId(varpId, bit);
+			String musicTrackName = names.getStringValue(musicTrackId);
+
+			sendChatMessage("You have unlocked a new music track: " + musicTrackName + ".");
+		}
+	}
+
+	/**
+	 * Get the id for a track identified by the given varp and a bit index
+	 * @param variableId
+	 * @param bit
+	 * @return
+	 */
+	private int getTrackId(int variableId, int bit)
+	{
+		// values are packed into a coordgrid
+		int packed = (variableId << 14) | bit;
+		EnumComposition ids = client.getEnum(EnumID.MUSIC_TRACK_IDS);
+		for (int key : ids.getKeys())
+		{
+			int value = ids.getIntValue(key);
+			if (value == packed)
+			{
+				return key;
+			}
+		}
+		return -1;
+	}
+
+	private void sendChatMessage(String chatMessage)
+	{
+		final String message = new ChatMessageBuilder()
+			.append(ChatColorType.HIGHLIGHT)
+			.append(chatMessage)
+			.build();
+
+		chatMessageManager.queue(
+			QueuedMessage.builder()
+				.type(ChatMessageType.GAME)
+				.runeLiteFormattedMessage(message)
+				.build());
+	}
+}

runescape-api/src/main/java/net/runelite/rs/api/RSEnum.java

@@ -30,6 +30,7 @@ import net.runelite.mapping.Import;
 public interface RSEnum extends EnumComposition, RSCacheableNode
 {
 	@Import("keys")
+	@Override
 	int[] getKeys();
 
 	@Import("intVals")