net.runelite.api

Interface ObjectComposition

public interface ObjectComposition

Information about a specific ObjectID

Method Summary

Modifier and Type	Method and Description
String[]	getActions() The 5 menuops this object has when in world.
int	getId() Gets ID for the object.
ObjectComposition	getImpostor() Get the object composition the player's state says this object should transmogrify into.
int[]	getImpostorIds() Get the ObjectIDs of objects this can transform into, depending on a Varbits or VarPlayer
int	getMapIconId() Gets the index of this object in the Client.getMapIcons() array, or -1 if it has no full map icon
int	getMapSceneId() Gets the index of this object in the Client.getMapScene() array, or -1 if it has no map scene icon
String	getName() Gets the name of the object.

Method Detail

getId

int getId()

Gets ID for the object.

See Also:

ObjectID

getName

String getName()

Gets the name of the object.

getActions

String[] getActions()

The 5 menuops this object has when in world. Index 0 corresponds to MenuAction.GAME_OBJECT_FIRST_OPTION, Index 2 to MenuAction.GAME_OBJECT_SECOND_OPTION and so on.

getMapSceneId

int getMapSceneId()

Gets the index of this object in the Client.getMapScene() array, or -1 if it has no map scene icon

getMapIconId

int getMapIconId()

Gets the index of this object in the Client.getMapIcons() array, or -1 if it has no full map icon

getImpostorIds

int[] getImpostorIds()

Get the ObjectIDs of objects this can transform into, depending on a Varbits or VarPlayer

getImpostor

ObjectComposition getImpostor()

Get the object composition the player's state says this object should transmogrify into.

Throws:

NullPointerException - if getImpostorIds() is null