Package net.runelite.api

Enum EquipmentInventorySlot

java.lang.Object

java.lang.Enum<EquipmentInventorySlot>

net.runelite.api.EquipmentInventorySlot

All Implemented Interfaces:

Serializable, Comparable<EquipmentInventorySlot>

public enum EquipmentInventorySlot
extends Enum<EquipmentInventorySlot>

An enumeration of equipment slots in the inventory ItemContainer.

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

See Also:

Client.getItemContainer(InventoryID), InventoryID.EQUIPMENT

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMMO
AMULET
BODY
BOOTS
CAPE
GLOVES
HEAD
LEGS
RING
SHIELD
WEAPON

Method Summary

Modifier and Type	Method	Description
int	getSlotIdx()	Gets the index into the item array obtained from ItemContainer.getItems().
static EquipmentInventorySlot	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EquipmentInventorySlot[]	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 EquipmentInventorySlot HEAD

CAPE

public static final EquipmentInventorySlot CAPE

AMULET

public static final EquipmentInventorySlot AMULET

WEAPON

public static final EquipmentInventorySlot WEAPON

BODY

public static final EquipmentInventorySlot BODY

SHIELD

public static final EquipmentInventorySlot SHIELD

LEGS

public static final EquipmentInventorySlot LEGS

GLOVES

public static final EquipmentInventorySlot GLOVES

BOOTS

public static final EquipmentInventorySlot BOOTS

RING

public static final EquipmentInventorySlot RING

AMMO

public static final EquipmentInventorySlot AMMO

Method Detail

values

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

Returns:

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

valueOf

public static EquipmentInventorySlot 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

getSlotIdx

public int getSlotIdx()

Gets the index into the item array obtained from ItemContainer.getItems().

Returns:

the raw index