Package net.runelite.api.kit

Enum KitType

java.lang.Object

java.lang.Enum<KitType>

net.runelite.api.kit.KitType

All Implemented Interfaces:

Serializable, Comparable<KitType>

public enum KitType
extends Enum<KitType>

Represents an equipment slot in a players composition.

These values are intended for use with PlayerComposition equipment slots. For obtaining information about equipment in the local players equipment ItemContainer, use EquipmentInventorySlot.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMULET
ARMS
BOOTS
CAPE
HAIR
HANDS
HEAD
JAW
LEGS
SHIELD
TORSO
WEAPON

Method Summary

Modifier and Type	Method	Description
int	getIndex()	Gets the raw equipment index for use in PlayerComposition.getEquipmentIds().
static KitType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KitType[]	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

HEAD

public static final KitType HEAD

CAPE

public static final KitType CAPE

AMULET

public static final KitType AMULET

WEAPON

public static final KitType WEAPON

TORSO

public static final KitType TORSO

SHIELD

public static final KitType SHIELD

ARMS

public static final KitType ARMS

LEGS

public static final KitType LEGS

HAIR

public static final KitType HAIR

HANDS

public static final KitType HANDS

BOOTS

public static final KitType BOOTS

JAW

public static final KitType JAW

Method Detail

values

public static KitType[] 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 (KitType c : KitType.values())
    System.out.println(c);

Returns:

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

valueOf

public static KitType valueOf(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:

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

NullPointerException - if the argument is null

getIndex

public int getIndex()

Gets the raw equipment index for use in PlayerComposition.getEquipmentIds().

Returns:

raw equipment index