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

Merge remote-tracking branch 'runelite/master'

Browse Source
This commit is contained in:
Owain van Brakel
2022-06-21 23:20:01 +02:00
parent bf554db646 8972a6de25
commit 0a81939200
3 changed files with 65 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -35,6 +35,7 @@ import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import net.runelite.api.annotations.Varbit;
import net.runelite.api.annotations.VisibleForDevtools;
import net.runelite.api.annotations.VisibleForExternalPlugins;
import net.runelite.api.clan.ClanChannel;
import net.runelite.api.clan.ClanID;
@@ -849,12 +850,21 @@ public interface Client extends OAuthApi, GameEngine
int[][] getXteaKeys();
/**
* Gets an array of all client variables.
* Gets an array of all client varplayers.
*
* @return local player variables
*/
int[] getVarps();
/**
* Get an array of all server varplayers. These vars are only
* modified by the server, and so represent the server's idea of
* the varp values.
* @return the server varps
*/
@VisibleForDevtools
int[] getServerVarps();
/**
* Gets an array of all client variables.
*/
@@ -868,6 +878,17 @@ public interface Client extends OAuthApi, GameEngine
*/
int getVar(VarPlayer varPlayer);
/**
* Gets the value corresponding to the passed player variable.
* This returns the server's idea of the value, not the client's. This is
* specifically the last value set by the server regardless of changes to
* the var by the client.
*
* @param varPlayer the player variable
* @return the value
*/
int getServerVar(VarPlayer varPlayer);
/**
* Gets a value corresponding to the passed varbit.
*
@@ -879,13 +900,23 @@ public interface Client extends OAuthApi, GameEngine
int getVar(@Varbit int varbit);
/**
* Gets a value corresponding to the passed varbit.
* Gets the value of the given varbit.
*
* @param varbit the varbit id
* @return the value
*/
int getVarbitValue(@Varbit int varbit);
/**
* Gets the value of the given varbit.
* This returns the server's idea of the value, not the client's. This is
* specifically the last value set by the server regardless of changes to
* the var by the client.
* @param varbit the varbit id
* @return the value
*/
int getServerVarbitValue(@Varbit int varbit);
/**
* Gets an int value corresponding to the passed variable.
*
@@ -902,6 +933,27 @@ public interface Client extends OAuthApi, 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 VarPlayer.
* This returns the server's idea of the value, not the client's. This is
* specifically the last value set by the server regardless of changes to
* the var by the client.
*
* @param varpId the VarPlayer id
* @return the value
*/
@VisibleForExternalPlugins
int getServerVarpValue(int varpId);
/**
* Gets the value of a given VarClientInt
*
@@ -967,8 +1019,6 @@ public interface Client extends OAuthApi, GameEngine
*/
int getVarpValue(int[] varps, int varpId);
int getVarpValue(int i);
/**
* Sets the value of a given variable.
*