Package net.runelite.api

Enum VarClientStr

java.lang.Object

java.lang.Enum<VarClientStr>

net.runelite.api.VarClientStr

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VarClientStr>

public enum VarClientStr
extends java.lang.Enum<VarClientStr>

Client side only, content-developer strings VarCInts are stored entirely in memory, or locally on a user's machine in the preferences2.dat file depending on how Jagex configured the variable

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHATBOX_TYPED_TEXT
INPUT_TEXT
NOTIFICATION_BOTTOM_TEXT
NOTIFICATION_TOP_TEXT
PRIVATE_MESSAGE_TARGET
RECENT_FRIENDS_CHAT

Method Summary

Modifier and Type	Method	Description
int	getIndex()
static VarClientStr	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static VarClientStr[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHATBOX_TYPED_TEXT

public static final VarClientStr CHATBOX_TYPED_TEXT

INPUT_TEXT

public static final VarClientStr INPUT_TEXT

PRIVATE_MESSAGE_TARGET

public static final VarClientStr PRIVATE_MESSAGE_TARGET

RECENT_FRIENDS_CHAT

public static final VarClientStr RECENT_FRIENDS_CHAT

NOTIFICATION_TOP_TEXT

public static final VarClientStr NOTIFICATION_TOP_TEXT

NOTIFICATION_BOTTOM_TEXT

public static final VarClientStr NOTIFICATION_BOTTOM_TEXT

Method Detail

values

public static VarClientStr[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VarClientStr c : VarClientStr.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VarClientStr valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getIndex

public int getIndex()