runelite-api: add sprite override api

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

@@ -410,6 +410,12 @@ public interface Client extends GameEngine
 	@VisibleForDevtools
 	void setChangedSkillsCount(int i);
 
+	void setSpriteOverrides(Map<Integer, SpritePixels> overrides);
+
+	void setWidgetSpriteOverrides(Map<Integer, SpritePixels> overrides);
+
+	void setCompass(SpritePixels spritePixels);
+
 	int getTickCount();
 
 	void setTickCount(int tickCount);

runelite-mixins/src/main/java/net/runelite/mixins/SpriteMixin.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2018, Lotto <https://github.com/devLotto>
+ * 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 HOLDER 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.mixins;
+
+import java.util.Map;
+import net.runelite.api.SpritePixels;
+import net.runelite.api.mixins.Copy;
+import net.runelite.api.mixins.Inject;
+import net.runelite.api.mixins.Mixin;
+import net.runelite.api.mixins.Replace;
+import net.runelite.rs.api.RSClient;
+import net.runelite.rs.api.RSIndexDataBase;
+import net.runelite.rs.api.RSSpritePixels;
+
+@Mixin(RSClient.class)
+public abstract class SpriteMixin implements RSClient
+{
+	@Inject
+	private static Map<Integer, SpritePixels> spriteOverrides;
+
+	@Inject
+	private static Map<Integer, SpritePixels> widgetSpriteOverrides;
+
+	@Inject
+	@Override
+	public void setSpriteOverrides(Map<Integer, SpritePixels> overrides)
+	{
+		getWidgetSpriteCache().reset();
+		spriteOverrides = overrides;
+	}
+
+	@Inject
+	@Override
+	public void setWidgetSpriteOverrides(Map<Integer, SpritePixels> overrides)
+	{
+		widgetSpriteOverrides = overrides;
+	}
+
+	@Copy("getSpriteAsSpritePixels")
+	public static RSSpritePixels rs$loadSprite(RSIndexDataBase var0, int var1, int var2)
+	{
+		throw new RuntimeException();
+	}
+
+	@Replace("getSpriteAsSpritePixels")
+	public static RSSpritePixels rl$loadSprite(RSIndexDataBase var0, int var1, int var2)
+	{
+		if (spriteOverrides != null)
+		{
+			SpritePixels sprite = spriteOverrides.get(var1);
+
+			if (sprite != null)
+			{
+				return (RSSpritePixels) sprite;
+			}
+		}
+
+		return rs$loadSprite(var0, var1, var2);
+	}
+}

runelite-mixins/src/main/java/net/runelite/mixins/WidgetSpriteMixin.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2018, Lotto <https://github.com/devLotto>
+ * 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 HOLDER 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.mixins;
+
+import java.util.Map;
+import net.runelite.api.SpritePixels;
+import net.runelite.api.mixins.Copy;
+import net.runelite.api.mixins.Mixin;
+import net.runelite.api.mixins.Replace;
+import net.runelite.api.mixins.Shadow;
+import net.runelite.rs.api.RSSpritePixels;
+import net.runelite.rs.api.RSWidget;
+
+@Mixin(RSWidget.class)
+public abstract class WidgetSpriteMixin implements RSWidget
+{
+	@Shadow("widgetSpriteOverrides")
+	private static Map<Integer, SpritePixels> widgetSpriteOverrides;
+
+	@Copy("getWidgetSprite")
+	public RSSpritePixels rs$getWidgetSprite(boolean var1)
+	{
+		throw new RuntimeException();
+	}
+
+	@Replace("getWidgetSprite")
+	public RSSpritePixels rl$getWidgetSprite(boolean var1)
+	{
+		if (getSpriteId() != -1 && widgetSpriteOverrides != null)
+		{
+			SpritePixels sprite = widgetSpriteOverrides.get(getId());
+
+			if (sprite != null)
+			{
+				return (RSSpritePixels) sprite;
+			}
+		}
+
+		return rs$getWidgetSprite(var1);
+	}
+}