Package net.runelite.api

Interface NPCComposition

All Superinterfaces:

ParamHolder

public interface NPCComposition
extends ParamHolder

Information about a specific NpcID

Field Summary

Fields

Modifier and Type	Field	Description
static int	STAT_ATTACK
static int	STAT_DEFENCE
static int	STAT_HITPOINTS
static int	STAT_MAGIC
static int	STAT_RANGED
static int	STAT_STRENGTH

Method Summary

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()	Get the NpcIDs of NPCs this can transform into, depending on a VarbitID or VarPlayerID
int	getFootprintSize()	Get the npc footprint size
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 is
int[]	getStats()	Get the npc's stats
int	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 options
boolean	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

Field Detail

STAT_ATTACK

static final int STAT_ATTACK

See Also:

Constant Field Values

STAT_DEFENCE

static final int STAT_DEFENCE

See Also:

Constant Field Values

STAT_STRENGTH

static final int STAT_STRENGTH

See Also:

Constant Field Values

STAT_HITPOINTS

static final int STAT_HITPOINTS

See Also:

Constant Field Values

STAT_RANGED

static final int STAT_RANGED

See Also:

Constant Field Values

STAT_MAGIC

static final int STAT_MAGIC

See Also:

Constant Field Values

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 to MenuAction.NPC_FIRST_OPTION, Index 2 to MenuAction.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()

Get the NpcIDs of NPCs this can transform into, depending on a VarbitID or VarPlayerID

transform

NPCComposition transform()

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

Throws:

NullPointerException - if getConfigs() 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:

getFootprintSize

int getFootprintSize()

Get the npc footprint size

Returns:

getStats

int[] getStats()

Get the npc's stats

Returns:

See Also:

STAT_ATTACK, STAT_DEFENCE, STAT_STRENGTH, STAT_HITPOINTS, STAT_RANGED, STAT_MAGIC