runelite-client: add methods for externals (plugin-hub) (#2286)

* Merge pull request #/10524 from Trevor159/get-var

Add getVar methods for external plugins

* Add the mixins

* fix dumb yaml error

recommend https://yaml-online-parser.appspot.com/

Co-authored-by: Adam <adam@sigterm.info>

.github/workflows/scraper.yml

@@ -13,7 +13,7 @@ jobs:
         with:
           repository: open-osrs/runelite
           ref: master
-        -
+
       - uses: actions/checkout@v1
         with:
           repository: open-osrs/cache-client

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

@@ -33,6 +33,7 @@ import java.util.Map;
 import java.util.Set;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
+import net.runelite.api.annotations.VisibleForExternalPlugins;
 import net.runelite.api.coords.LocalPoint;
 import net.runelite.api.coords.WorldPoint;
 import net.runelite.api.hooks.Callbacks;
@@ -703,6 +704,42 @@ public interface Client extends GameShell
 	 */
 	String getVar(VarClientStr varClientStr);
 
+	/**
+	 * Gets the value of a given VarPlayer.
+	 *
+	 * @param varpId the VarPlayer id
+	 * @return the value
+	 */
+	@VisibleForExternalPlugins
+	int getVarpValue(int varpId);
+
+	/**
+	 * Gets the value of a given Varbit.
+	 *
+	 * @param varbitId the varbit id
+	 * @return the value
+	 */
+	@VisibleForExternalPlugins
+	int getVarbitValue(int varbitId);
+
+	/**
+	 * Gets the value of a given VarClientInt
+	 *
+	 * @param varcIntId the VarClientInt id
+	 * @return the value
+	 */
+	@VisibleForExternalPlugins
+	int getVarcIntValue(int varcIntId);
+
+	/**
+	 * Gets the value of a given VarClientStr
+	 *
+	 * @param varcStrId the VarClientStr id
+	 * @return the value
+	 */
+	@VisibleForExternalPlugins
+	String getVarcStrValue(int varcStrId);
+
 	/**
 	 * Sets a VarClientString to the passed value
 	 */

runelite-api/src/main/java/net/runelite/api/annotations/VisibleForExternalPlugins.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2019, Trevor <https://github.com/Trevor159>
+ * 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.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Used to indicate a method is only visible for external plugins
+ */
+@Documented
+@Retention(RetentionPolicy.SOURCE)
+public @interface VisibleForExternalPlugins
+{
+}

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

@@ -591,6 +591,13 @@ public abstract class RSClientMixin implements RSClient
 		return varps[varpId];
 	}
 
+	@Inject
+	@Override
+	public int getVarpValue(int varpId)
+	{
+		return getVarpValue(getVarps(), varpId);
+	}
+
 	@Inject
 	@Override
 	public void setVarpValue(int[] varps, int varpId, int value)

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

@@ -37,6 +37,13 @@ public abstract class VarbitMixin implements RSClient
 		return getVarbitValue(getVarps(), varbitId);
 	}
 
+	@Inject
+	@Override
+	public int getVarbitValue(int varbitId)
+	{
+		return getVarbitValue(getVarps(), varbitId);
+	}
+
 	@Inject
 	@Override
 	public void setVarbit(Varbits varbit, int value)
@@ -94,18 +101,32 @@ public abstract class VarbitMixin implements RSClient
 	@Inject
 	@Override
 	public int getVar(VarClientInt varClientInt)
+	{
+		return getVarcIntValue(varClientInt.getIndex());
+	}
+
+	@Inject
+	@Override
+	public int getVarcIntValue(int varcIntId)
 	{
 		Map<Integer, Object> varcmap = getVarcMap();
-		Object object = varcmap.get(varClientInt.getIndex());
+		Object object = varcmap.get(varcIntId);
 		return object instanceof Integer ? (Integer) object : 0;
 	}
 
 	@Inject
 	@Override
 	public String getVar(VarClientStr varClientStr)
+	{
+		return getVarcStrValue(varClientStr.getIndex());
+	}
+
+	@Inject
+	@Override
+	public String getVarcStrValue(int varcStrId)
 	{
 		Map<Integer, Object> varcmap = getVarcMap();
-		Object var2 = varcmap.get(varClientStr.getIndex());
+		Object var2 = varcmap.get(varcStrId);
 		return var2 instanceof String ? (String) var2 : "";
 	}