Package net.runelite.api

Interface NPC

All Superinterfaces:

Actor, CameraFocusableEntity, Node, Renderable

public interface NPC
extends Actor

Represents a non-player character in the game.

Method Summary

Modifier and Type	Method	Description
NpcOverrides	getChatheadOverrides()
int	getCombatLevel()	Gets the combat level of the actor.
NPCComposition	getComposition()	Gets the composition of this NPC.
int	getId()	Gets the ID of the NPC.
int	getIndex()	Gets the index position of this NPC in the clients cached NPC array.
NpcOverrides	getModelOverrides()
String	getName()	Gets the name of the actor.
int[]	getOverheadArchiveIds()	Get the array of overhead icon archive ids.
short[]	getOverheadSpriteIds()	Get the array of overhead icon sprite indexes.
NPCComposition	getTransformedComposition()	Get the composition for this NPC and transform it if required

Methods inherited from interface net.runelite.api.Actor

clearSpotAnims, createSpotAnim, getAnimation, getAnimationFrame, getAnimationHeightOffset, getCanvasImageLocation, getCanvasSpriteLocation, getCanvasTextLocation, getCanvasTilePoly, getConvexHull, getCurrentOrientation, getGraphic, getGraphicHeight, getHealthRatio, getHealthScale, getIdlePoseAnimation, getIdleRotateLeft, getIdleRotateRight, getInteracting, getLocalLocation, getLogicalHeight, getMinimapLocation, getOrientation, getOverheadCycle, getOverheadText, getPoseAnimation, getPoseAnimationFrame, getRunAnimation, getSpotAnimFrame, getSpotAnims, getWalkAnimation, getWalkRotate180, getWalkRotateLeft, getWalkRotateRight, getWorldArea, getWorldLocation, getWorldView, hasSpotAnim, isDead, isInteracting, removeSpotAnim, setActionFrame, setAnimation, setAnimationFrame, setDead, setGraphic, setGraphicHeight, setIdlePoseAnimation, setIdleRotateLeft, setIdleRotateRight, setOverheadCycle, setOverheadText, setPoseAnimation, setPoseAnimationFrame, setRunAnimation, setSpotAnimFrame, setWalkAnimation, setWalkRotate180, setWalkRotateLeft, setWalkRotateRight

Methods inherited from interface net.runelite.api.CameraFocusableEntity

getCameraFocus

Methods inherited from interface net.runelite.api.Node

getHash, getNext, getPrevious

Methods inherited from interface net.runelite.api.Renderable

getModel, getModelHeight, setModelHeight

Method Detail

getId

int getId()

Gets the ID of the NPC.

Returns:

the ID of the NPC

See Also:

NpcID

getName

String getName()

Description copied from interface: Actor

Gets the name of the actor.

Specified by:

getName in interface Actor

Returns:

the name

getCombatLevel

int getCombatLevel()

Description copied from interface: Actor

Gets the combat level of the actor.

Specified by:

getCombatLevel in interface Actor

Returns:

the combat level

getIndex

int getIndex()

Gets the index position of this NPC in the clients cached NPC array.

Returns:

the NPC index

getComposition

NPCComposition getComposition()

Gets the composition of this NPC.

Returns:

the composition

getTransformedComposition

@Nullable
NPCComposition getTransformedComposition()

Get the composition for this NPC and transform it if required

Returns:

the transformed NPC

getModelOverrides

@Nullable
NpcOverrides getModelOverrides()

getChatheadOverrides

@Nullable
NpcOverrides getChatheadOverrides()

getOverheadArchiveIds

@Nullable
int[] getOverheadArchiveIds()

Get the array of overhead icon archive ids. Used in conjunction with getOverheadSpriteIds() to determine which icons are being rendered overhead.

Returns:

A sparse array of archive ids. Values of -1 are not used.

See Also:

getOverheadSpriteIds()

getOverheadSpriteIds

@Nullable
short[] getOverheadSpriteIds()

Get the array of overhead icon sprite indexes. Used in conjunction with getOverheadArchiveIds() to determine which icons are being rendered overhead.

Returns:

A sparse array of archive ids. Values of -1 are not used.

See Also:

getOverheadArchiveIds()