ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

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

Browse Source 
* 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>
This commit is contained in:
ThatGamerBlue
2020-01-26 02:33:46 +00:00
committed by Kyle
parent 6cca168162
commit 014d1f095c
5 changed files with 106 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
runelite-api/src/main/java/net/runelite/api/Client.java
View File

@@ -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
*/

38
runelite-api/src/main/java/net/runelite/api/annotations/VisibleForExternalPlugins.java Normal file
View File

@@ -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
{
}