From bc6a22423721e3c4ecd30244a3e1a2395c1aa2d6 Mon Sep 17 00:00:00 2001 From: 15987632 Date: Mon, 30 Dec 2019 19:55:01 -0500 Subject: [PATCH 1/2] client: add VisibleForExternalPlugins annotation --- .../VisibleForExternalPlugins.java | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 runelite-api/src/main/java/net/runelite/api/annotations/VisibleForExternalPlugins.java diff --git a/runelite-api/src/main/java/net/runelite/api/annotations/VisibleForExternalPlugins.java b/runelite-api/src/main/java/net/runelite/api/annotations/VisibleForExternalPlugins.java new file mode 100644 index 0000000000..8046e92bde --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/annotations/VisibleForExternalPlugins.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2019, Trevor + * 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 +{ +} From 1af81d40bec964245181262757222c38d23790ac Mon Sep 17 00:00:00 2001 From: 15987632 Date: Mon, 30 Dec 2019 19:55:25 -0500 Subject: [PATCH 2/2] client: add getVar methods for external plugins --- .../main/java/net/runelite/api/Client.java | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/runelite-api/src/main/java/net/runelite/api/Client.java b/runelite-api/src/main/java/net/runelite/api/Client.java index ea20abdccf..063e833f89 100644 --- a/runelite-api/src/main/java/net/runelite/api/Client.java +++ b/runelite-api/src/main/java/net/runelite/api/Client.java @@ -32,6 +32,7 @@ import java.util.Map; import javax.annotation.Nonnull; import javax.annotation.Nullable; import net.runelite.api.annotations.VisibleForDevtools; +import net.runelite.api.annotations.VisibleForExternalPlugins; import net.runelite.api.coords.LocalPoint; import net.runelite.api.coords.WorldPoint; import net.runelite.api.hooks.Callbacks; @@ -686,6 +687,42 @@ public interface Client extends GameEngine */ 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 */