Package net.runelite.api
Interface ObjectComposition
-
- All Superinterfaces:
ParamHolder
public interface ObjectComposition extends ParamHolder
Information about a specificObjectID
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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()
int
getMapIconId()
Gets the index of this object in theClient.getMapIcons()
array, or -1 if it has no full map iconint
getMapSceneId()
Gets the index of this object in theClient.getMapScene()
array, or -1 if it has no map scene iconString
getName()
Gets the name of the object.int
getSizeX()
Get the size of the object on the X-axis in tilesint
getSizeY()
Get the size of the object on the Y-axis in tilesint
getVarbitId()
Gets theVarbits
used to switch this multiloc, or-1
if this is not switched by a Varbitint
getVarPlayerId()
Gets theVarPlayer
used to switch this multiloc, or-1
if this is not switched by a VarPlayervoid
setMapIconId(int mapIconId)
Set the index of the object in theClient.getMapIcons()
array, or -1 if it has no map iconvoid
setMapSceneId(int mapSceneId)
Set the map scene index into theClient.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 toMenuAction.GAME_OBJECT_FIRST_OPTION
, Index 2 toMenuAction.GAME_OBJECT_SECOND_OPTION
and so on.
-
getMapSceneId
int getMapSceneId()
Gets the index of this object in theClient.getMapScene()
array, or -1 if it has no map scene icon
-
setMapSceneId
void setMapSceneId(int mapSceneId)
Set the map scene index into theClient.getMapScene()
array, or -1 if it has no map scene icon- Parameters:
mapSceneId
-
-
getMapIconId
int getMapIconId()
Gets the index of this object in theClient.getMapIcons()
array, or -1 if it has no full map icon
-
setMapIconId
void setMapIconId(int mapIconId)
Set the index of the object in theClient.getMapIcons()
array, or -1 if it has no map icon- Parameters:
mapIconId
-
-
getImpostorIds
int[] getImpostorIds()
-
getImpostor
ObjectComposition getImpostor()
Get the object composition the player's state says this object should transmogrify into.- Throws:
NullPointerException
- ifgetImpostorIds()
is null
-
getVarbitId
@Varbit int getVarbitId()
Gets theVarbits
used to switch this multiloc, or-1
if this is not switched by a Varbit- See Also:
getImpostor()
,getImpostorIds()
-
getVarPlayerId
int getVarPlayerId()
Gets theVarPlayer
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:
-
-