org.osbot.rs07.api.def

Class NPCDefinition

java.lang.Object

org.osbot.rs07.api.def.NPCDefinition

All Implemented Interfaces:

EntityDefinition

public class NPCDefinition
extends java.lang.Object
implements EntityDefinition

Represents the definition of an NPC in the game.

Constructor Summary

Constructors

Constructor and Description
NPCDefinition(org.osbot.rs07.accessor.XNPCDefinition def)

Method Summary

Modifier and Type	Method and Description
static void	add(org.osbot.rs07.accessor.XNPCDefinition def) Caches the item definition and wraps it.
static NPCDefinition	forId(int id) Gets the definition for an NPC based on it's id.
java.lang.String[]	getActions() Gets the actions of the NPC.
int	getHeadIcon() Deprecated.
int[]	getHeadIconArchives() Gets the head icon archive ids for this npc.
short[]	getHeadIconSprites() Gets the head icon sprites for this npc.
int	getId() Gets the NPC id.
int	getLevel() Gets the combat level of the NPC.
int[]	getModelIds() Gets the array of model ids use by this NPC.
short[]	getModifiedModelColors() Gets what is called modified model colors of the object definition.
java.lang.String	getName() Gets the name of the NPC.
short[]	getOriginalModelColors() Gets what is called original model colors of the object definition.
int	getRealId() Gets the current real id of the NPC.
int	getSize() Gets the size in tiles of the npc
boolean	isVisible() Checks if the npc should be rendered
boolean	isVisibleOnMinimap() Checks if this npc dot is visible on minimap
static void	setTransformIndex(int id, int realId) Deprecated. for internal use only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NPCDefinition

public NPCDefinition(org.osbot.rs07.accessor.XNPCDefinition def)

Method Detail

add

public static void add(org.osbot.rs07.accessor.XNPCDefinition def)

Caches the item definition and wraps it.

Parameters:

def - The definition to add

setTransformIndex

@Deprecated
public static void setTransformIndex(int id,
                                                  int realId)

Deprecated. for internal use only.

Parameters:

id - The id of the definition

realId - The transform index

forId

public static NPCDefinition forId(int id)

Gets the definition for an NPC based on it's id. Note: This method might return null because the NPC hasn't been loaded by the client yet!

Parameters:

id - The npc id.

Returns:

The npc definition.

getId

public int getId()

Gets the NPC id.

Returns:

The NPC id.

getRealId

public int getRealId()

Gets the current real id of the NPC. This is its normal id unless the NPC has been transformed, in that case the transformation id is given.

Returns:

The current real id of the NPC.

getName

public java.lang.String getName()

Gets the name of the NPC.

Returns:

The NPC name.

getLevel

public int getLevel()

Gets the combat level of the NPC.

Returns:

The NPC combat level.

getModelIds

public int[] getModelIds()

Gets the array of model ids use by this NPC.

Specified by:

getModelIds in interface EntityDefinition

Returns:

The array of models.

getActions

public java.lang.String[] getActions()

Gets the actions of the NPC.

Specified by:

getActions in interface EntityDefinition

Returns:

The NPC actions.

getModifiedModelColors

public short[] getModifiedModelColors()

Gets what is called modified model colors of the object definition.

Specified by:

getModifiedModelColors in interface EntityDefinition

Returns:

The modified model colors array.

getOriginalModelColors

public short[] getOriginalModelColors()

Gets what is called original model colors of the object definition.

Specified by:

getOriginalModelColors in interface EntityDefinition

Returns:

The original model colors array.

getHeadIcon

@Deprecated
public int getHeadIcon()

Deprecated.

Gets the head icon id for this npc.

Returns:

The head icon id for this npc.

getHeadIconArchives

public int[] getHeadIconArchives()

Gets the head icon archive ids for this npc.

Returns:

The head icon archive ids for this npc.

getHeadIconSprites

public short[] getHeadIconSprites()

Gets the head icon sprites for this npc.

Returns:

The head icon sprites for this npc.

isVisible

public boolean isVisible()

Checks if the npc should be rendered

Returns:

True if this npc is visible.

isVisibleOnMinimap

public boolean isVisibleOnMinimap()

Checks if this npc dot is visible on minimap

Returns:

True if this npc dot is visible on minimap

getSize

public int getSize()

Gets the size in tiles of the npc

Returns:

The size in tiles of the npc