Package net.runelite.api
Interface NPCComposition
-
- All Superinterfaces:
ParamHolder
public interface NPCComposition extends ParamHolder
Information about a specificNpcID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String[]
getActions()
The 5 menuops this NPC has when in world.short[]
getColorToReplace()
Get the colors to be replaced on this npc's model for this npc.short[]
getColorToReplaceWith()
Get the colors applied to this npc's model for this npc.int
getCombatLevel()
int[]
getConfigs()
int
getHeightScale()
Vertical scaling of the npc model (1/128th of a tile).int
getId()
Gets the ID of the NPC.int[]
getModels()
Gets the model IDs that compose this NPC.String
getName()
Gets the name of the NPC.int
getSize()
How many tiles wide this NPC isint
getWidthScale()
Horizontal scaling of the npc model (1/128th of a tile).boolean
isFollower()
If the npc is a follower, such as a pet.boolean
isInteractible()
NPC can be interacting with via menu optionsboolean
isMinimapVisible()
Gets whether the NPC is visible on the mini-map.boolean
isVisible()
NPCComposition
transform()
Get the NPC composition the player's state says this NPC should transmogrify into.-
Methods inherited from interface net.runelite.api.ParamHolder
getIntValue, getParams, getStringValue, setParams, setValue, setValue
-
-
-
-
Method Detail
-
getName
String getName()
Gets the name of the NPC.
-
getModels
int[] getModels()
Gets the model IDs that compose this NPC.
-
getActions
String[] getActions()
The 5 menuops this NPC has when in world. Index 0 corresponds toMenuAction.NPC_FIRST_OPTION
, Index 2 toMenuAction.NPC_SECOND_OPTION
and so on.
-
isInteractible
boolean isInteractible()
NPC can be interacting with via menu options- Returns:
-
isMinimapVisible
boolean isMinimapVisible()
Gets whether the NPC is visible on the mini-map.
-
isVisible
boolean isVisible()
-
getId
int getId()
Gets the ID of the NPC.- See Also:
NpcID
-
getCombatLevel
int getCombatLevel()
- Returns:
- the combat level, -1 if none
-
getConfigs
int[] getConfigs()
-
transform
NPCComposition transform()
Get the NPC composition the player's state says this NPC should transmogrify into.- Throws:
NullPointerException
- ifgetConfigs()
is null
-
getSize
int getSize()
How many tiles wide this NPC is
-
isFollower
boolean isFollower()
If the npc is a follower, such as a pet. Is affected by the "Move follower options lower down" setting.- Returns:
-
getColorToReplace
@Nullable short[] getColorToReplace()
Get the colors to be replaced on this npc's model for this npc.- Returns:
- the colors to be replaced
- See Also:
JagexColor
-
getColorToReplaceWith
@Nullable short[] getColorToReplaceWith()
Get the colors applied to this npc's model for this npc.- Returns:
- the colors to replace with
- See Also:
JagexColor
-
getWidthScale
int getWidthScale()
Horizontal scaling of the npc model (1/128th of a tile).- Returns:
-
getHeightScale
int getHeightScale()
Vertical scaling of the npc model (1/128th of a tile).- Returns:
-
-