Package net.runelite.api

Interface ObjectComposition

All Superinterfaces:

ParamHolder

public interface ObjectComposition
extends ParamHolder

Information about a specific ObjectID

Method Summary

Modifier and Type	Method	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.
int	getSizeX()	Get the size of the object on the X-axis in tiles
int	getSizeY()	Get the size of the object on the Y-axis in tiles
int	getVarbitId()	Gets the Varbits used to switch this multiloc, or -1 if this is not switched by a Varbit
int	getVarPlayerId()	Gets the VarPlayer used to switch this multiloc, or -1 if this is not switched by a VarPlayer
void	setMapIconId(int mapIconId)	Set the index of the object in the Client.getMapIcons() array, or -1 if it has no map icon
void	setMapSceneId(int mapSceneId)	Set the map scene index into the Client.getMapScene() array, or -1 if it has no map scene icon

Methods inherited from interface net.runelite.api.ParamHolder

getIntValue, getParams, getStringValue, setParams, setValue, setValue

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

setMapSceneId

void setMapSceneId(int mapSceneId)

Set the map scene index into the Client.getMapScene() array, or -1 if it has no map scene icon

Parameters:

mapSceneId -

getMapIconId

int getMapIconId()

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

setMapIconId

void setMapIconId(int mapIconId)

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

Parameters:

mapIconId -

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

getVarbitId

@Varbit
int getVarbitId()

Gets the Varbits used to switch this multiloc, or -1 if this is not switched by a Varbit

See Also:

getImpostor(), getImpostorIds()

getVarPlayerId

int getVarPlayerId()

Gets the VarPlayer used to switch this multiloc, or -1 if this is not switched by a VarPlayer

See Also:

getImpostor(), getImpostorIds()

getSizeX

int getSizeX()

Get the size of the object on the X-axis in tiles

Returns:

getSizeY

int getSizeY()

Get the size of the object on the Y-axis in tiles

Returns: