Interface NPCComposition

interface NPCComposition {
    STAT_ATTACK: number;
    STAT_DEFENCE: number;
    STAT_STRENGTH: number;
    STAT_HITPOINTS: number;
    STAT_RANGED: number;
    STAT_MAGIC: number;
    getName(): string;
    getModels(): number[];
    getChatheadModels(): number[];
    getActions(): string[];
    isInteractible(): boolean;
    isMinimapVisible(): boolean;
    getId(): number;
    getCombatLevel(): number;
    getConfigs(): number[];
    transform(): NPCComposition;
    getSize(): number;
    isFollower(): boolean;
    getFootprintSize(): number;
    getWidthScale(): number;
    getHeightScale(): number;
    getStats(): number[];
}

Methods

getName

getName(): string
Gets the name of the NPC.

Returns string

getModels

getModels(): number[]
Gets the model IDs that compose this NPC.

Returns number[]

getChatheadModels

getChatheadModels(): number[]
Gets the model IDs that compose this NPC's chathead.

Returns number[]

getActions

getActions(): string[]
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.

Returns string[]

isInteractible

isInteractible(): boolean
NPC can be interacting with via menu options

Returns boolean

isMinimapVisible

isMinimapVisible(): boolean
Gets whether the NPC is visible on the mini-map.

Returns boolean

getId

getId(): number
Gets the ID of the NPC.

Returns number

getCombatLevel

getCombatLevel(): number
Returns number
the combat level, -1 if none

getConfigs

getConfigs(): number[]
Get the IDs of NPCs this can transform into, depending on a Varbit or VarPlayer id

Returns number[]

transform

transform(): NPCComposition
Get the NPC composition the player's state says this NPC should transmogrify into.

Returns NPCComposition
Throws
NullPointerException if getConfigs is null

getSize

getSize(): number
How many tiles wide this NPC is

Returns number

isFollower

isFollower(): boolean
If the npc is a follower, such as a pet. Is affected by the "Move follower options lower down" setting.

Returns boolean

getFootprintSize

getFootprintSize(): number
Get the npc footprint size

Returns number

getWidthScale

getWidthScale(): number
Horizontal scaling of the npc model (1/128th of a tile).

Returns number

getHeightScale

getHeightScale(): number
Vertical scaling of the npc model (1/128th of a tile).

Returns number

getStats

getStats(): number[]
Get the npc's stats

Returns number[]
See

Properties

STAT_ATTACK

STAT_ATTACK: number

STAT_DEFENCE

STAT_DEFENCE: number

STAT_STRENGTH

STAT_STRENGTH: number

STAT_HITPOINTS

STAT_HITPOINTS: number

STAT_RANGED

STAT_RANGED: number

STAT_MAGIC

STAT_MAGIC: number