Package com.osrsbots.orb.api.interactables.types

Class RSNpc

java.lang.Object

com.osrsbots.orb.api.interactables.types.RSNpc

All Implemented Interfaces:

RSActor

public class RSNpc
extends java.lang.Object
implements RSActor

Constructor Summary

Constructors

Constructor	Description
RSNpc(@NotNull net.runelite.api.NPC composition)

Method Summary

Modifier and Type	Method	Description
boolean	doAction(java.lang.String option)
boolean	doAction(net.runelite.api.MenuAction type, java.lang.String option)
@Nullable java.lang.String[]	getActions()
int	getAnimation()
short @Nullable []	getColorToReplace()
short @Nullable []	getColorToReplaceWith()
int	getCombatLevel()
net.runelite.api.NPCComposition	getComposition()
int @Nullable []	getConfigs()
int	getHeightScale()
int	getId()
int	getIndex()
int[]	getModels()
@Nullable java.lang.String	getName()
int	getSize()
int	getWidthScale()
boolean	interact(@Nullable net.runelite.api.MenuAction type, java.lang.String option)
boolean	interact(java.lang.String option)
boolean	isDead()
boolean	isFighting(java.lang.String targetName)
boolean	isFollower()
boolean	isInCombat()
boolean	isInteractible()
boolean	isInteracting()
boolean	isInteractingWith(java.lang.String targetName)
boolean	isMinimapVisible()
boolean	isMoving()
boolean	isVisible()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.osrsbots.orb.api.interactables.types.RSActor

distanceToPlayer, getAnimationFrame, getClickbox, getCurrentOrientation, getHealthRatio, getHealthScale, getIdlePoseAnimation, getIdleRotateLeft, getIdleRotateRight, getInteracting, getLocalLocation, getMinimapLocation, getModel, getOrientation, getOverheadCycle, getOverheadText, getPoseAnimation, getPoseAnimationFrame, getRunAnimation, getSpotAnims, getWalkAnimation, getWalkRotate180, getWalkRotateLeft, getWalkRotateRight, getWorldArea, getWorldLocation, getWorldView, hasSpotAnim, highlight, hover, isInteractable, isReachable, useWith

Constructor Detail

RSNpc

public RSNpc(@NotNull
             @NotNull net.runelite.api.NPC composition)

Method Detail

getComposition

public net.runelite.api.NPCComposition getComposition()

doAction

public boolean doAction(@Nonnull
                        java.lang.String option)

Specified by:

doAction in interface RSActor

doAction

public boolean doAction(@Nonnull
                        net.runelite.api.MenuAction type,
                        @Nonnull
                        java.lang.String option)

Specified by:

doAction in interface RSActor

interact

public boolean interact(@Nonnull
                        java.lang.String option)

Specified by:

interact in interface RSActor

interact

public boolean interact(@Nullable
                        @Nullable net.runelite.api.MenuAction type,
                        @Nonnull
                        java.lang.String option)

Specified by:

interact in interface RSActor

isInCombat

public boolean isInCombat()

isFighting

public boolean isFighting(@Nonnull
                          java.lang.String targetName)

isInteractingWith

public boolean isInteractingWith(@Nonnull
                                 java.lang.String targetName)

Specified by:

isInteractingWith in interface RSActor

isMoving

public boolean isMoving()

Specified by:

isMoving in interface RSActor

getAnimation

public int getAnimation()

Specified by:

getAnimation in interface RSActor

isInteracting

public boolean isInteracting()

Specified by:

isInteracting in interface RSActor

getIndex

public int getIndex()

isDead

public boolean isDead()

Specified by:

isDead in interface RSActor

getActions

@Nullable
public @Nullable java.lang.String[] getActions()

getName

@Nullable
public @Nullable java.lang.String getName()

Specified by:

getName in interface RSActor

getCombatLevel

public int getCombatLevel()

Specified by:

getCombatLevel in interface RSActor

getId

public int getId()

isFollower

public boolean isFollower()

isInteractible

public boolean isInteractible()

isVisible

public boolean isVisible()

isMinimapVisible

public boolean isMinimapVisible()

getSize

public int getSize()

getWidthScale

public int getWidthScale()

getHeightScale

public int getHeightScale()

getModels

public int[] getModels()

getConfigs

public int @Nullable [] getConfigs()

getColorToReplace

public short @Nullable [] getColorToReplace()

getColorToReplaceWith

public short @Nullable [] getColorToReplaceWith()