Package rs.kreme.ksbot.api.wrappers

Class KSNPC

java.lang.Object

rs.kreme.ksbot.api.wrappers.KSNPC

All Implemented Interfaces:

Interactable, Locatable, Positionable

public class KSNPC
extends java.lang.Object
implements Locatable, Interactable

Constructor Summary

Constructors

Constructor	Description
KSNPC(net.runelite.api.NPC npc)

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getActions()	Gets the actions available for the NPC.
int	getAnimation()
int	getCombatLevel()
net.runelite.api.NPCComposition	getComp()	Gets the NPC composition, which contains detailed data about the NPC.
net.runelite.api.HeadIcon	getHeadIcon()
int	getHealth()
int	getHealthPercentage()
int	getHealthRatio()
int	getId()	Gets the NPC ID.
int	getIndex()	Gets the NPC Index.
net.runelite.api.Actor	getInteracting()
java.lang.String	getName()	Gets the name of the NPC.
net.runelite.api.coords.WorldArea	getWorldArea()	Gets the NPC's world area (the region in which the NPC is located).
net.runelite.api.coords.WorldPoint	getWorldLocation()
void	interact(int action)	Interacts with the NPC using a specified action index.
void	interact(int index, net.runelite.api.MenuAction menuAction)
void	interact(int index, net.runelite.api.MenuAction menuAction, int param0, int param1)
boolean	interact(java.lang.String action)	Interacts with the NPC using a specified action name.
void	interact(net.runelite.api.MenuAction menuAction)
boolean	isAnimating()
boolean	isDead()	Checks if the NPC is dead.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface rs.kreme.ksbot.api.interfaces.Interactable

getClickBounds, getOptionIndex, hasAction

Methods inherited from interface rs.kreme.ksbot.api.interfaces.Locatable

distanceTo, distanceTo, getLocalLocation, getPlane, getWorldX, getWorldY

Constructor Detail

KSNPC

public KSNPC(net.runelite.api.NPC npc)

Method Detail

getId

public int getId()

Gets the NPC ID.

Returns:

the ID of the NPC.

getIndex

public int getIndex()

Gets the NPC Index.

Returns:

the Index of the NPC.

getName

public java.lang.String getName()

Gets the name of the NPC.

Returns:

the name of the NPC as a String.

getActions

public java.lang.String[] getActions()

Gets the actions available for the NPC.

Specified by:

getActions in interface Interactable

Returns:

an array of Strings representing the available actions.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getComp

public net.runelite.api.NPCComposition getComp()

Gets the NPC composition, which contains detailed data about the NPC.

Returns:

the NPCComposition object for the NPC.

getWorldArea

public net.runelite.api.coords.WorldArea getWorldArea()

Gets the NPC's world area (the region in which the NPC is located).

Returns:

the WorldArea object representing the NPC's location.

isDead

public boolean isDead()

Checks if the NPC is dead.

Returns:

true if the NPC is dead, false otherwise.

interact

public void interact(int action)

Interacts with the NPC using a specified action index.

Specified by:

interact in interface Interactable

Parameters:

action - the index of the action to perform (1-based).

interact

public boolean interact(java.lang.String action)

Interacts with the NPC using a specified action name.

Specified by:

interact in interface Interactable

Parameters:

action - the name of the action to perform (e.g., "Talk-to").

interact

public void interact(net.runelite.api.MenuAction menuAction)

Specified by:

interact in interface Interactable

getWorldLocation

public net.runelite.api.coords.WorldPoint getWorldLocation()

Specified by:

getWorldLocation in interface Locatable

Specified by:

getWorldLocation in interface Positionable

getAnimation

public int getAnimation()

isAnimating

public boolean isAnimating()

getHealthRatio

public int getHealthRatio()

getHealth

public int getHealth()

getHealthPercentage

public int getHealthPercentage()

getHeadIcon

public net.runelite.api.HeadIcon getHeadIcon()

getInteracting

public net.runelite.api.Actor getInteracting()

getCombatLevel

public int getCombatLevel()

interact

public void interact(int index,
                     net.runelite.api.MenuAction menuAction,
                     int param0,
                     int param1)

Specified by:

interact in interface Interactable

interact

public void interact(int index,
                     net.runelite.api.MenuAction menuAction)

Specified by:

interact in interface Interactable