Package org.dreambot.api.wrappers.interactive

Class NPC

    • Constructor Detail

      • NPC

        public NPC​(java.lang.Object reference)
        Note: This shouldn't be used by API users, it's an internal constructor.

    • Method Detail

      • getComposite

        public org.dreambot.internal.cache.wrappers.def.NPCDefinition getComposite()

      • getActions

        public java.lang.String[] getActions()
        Specified by:
        getActions in class Entity

      • getRecolorOriginal

        public short[] getRecolorOriginal()

      • getRecolorTarget

        public short[] getRecolorTarget()

      • isDrawMinimapDot

        public boolean isDrawMinimapDot()

      • getID

        public int getID()
        Description copied from interface: Identifiable
        Gets ID number of the given object.
        Returns:
        the ID number as integer.

      • getLevel

        public int getLevel()
        Description copied from class: Character
        Gets the Character's combat level.
        Specified by:
        getLevel in class Character
        Returns:
        the combat level of this Character.

      • getName

        public java.lang.String getName()
        Description copied from class: Entity
        Gets the name of the entity
        Specified by:
        getName in interface Identifiable
        Specified by:
        getName in class Entity
        Returns:
        name of entity

      • getIndex

        public int getIndex()
        Description copied from class: Character
        Gets the index of this Character.
        Specified by:
        getIndex in class Character
        Returns:
        this index location.

      • setIndex

        public void setIndex​(int index)

      • getModelIDs

        public int[] getModelIDs()

      • getSize

        public int getSize()

      • getRealID

        public int getRealID()

      • hasAction

        public boolean hasAction​(java.lang.String... actions)
        Description copied from class: Entity
        Checks whether given actions are in the list of menu actions for an entity
        Specified by:
        hasAction in class Entity
        Parameters:
        actions - actions to check
        Returns:
        true if all actions are in the list of menu actions

      • getHeadIcon

        @Deprecated
public int getHeadIcon()
        Deprecated.

      • getHeadIconArchiveIds

        public int[] getHeadIconArchiveIds()

      • getHeadIconSpriteIndex

        public short[] getHeadIconSpriteIndex()

      • getArea

        public Area getArea()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getRetextureToReplace

        public short[] getRetextureToReplace()

      • getRetextureToFind

        public short[] getRetextureToFind()

      • isMinimapDot

        @Deprecated
public boolean isMinimapDot()
        Deprecated.
        see isDrawMinimapDot()

      • getRecoloredTarget

        public short[] getRecoloredTarget()

      • getVarbitID

        public int getVarbitID()

      • getWalkingAnimation

        public int getWalkingAnimation()

      • getRecoloredOriginal

        public short[] getRecoloredOriginal()

      • getParams

        public java.util.Map<java.lang.Integer,​java.lang.Object> getParams()

      • isPet

        @Deprecated
public boolean isPet()
        Deprecated.
        see isFollower()

      • isFollower

        public boolean isFollower()

      • isLowPriorityFollowerOps

        public boolean isLowPriorityFollowerOps()

      • getCategory

        @Deprecated
public int getCategory()
        Deprecated.

      • isRotationFlag

        public boolean isRotationFlag()

      • getAdditionalModels

        public int[] getAdditionalModels()

      • getChildIDs

        public int[] getChildIDs()

      • getDegreesToTurn

        public int getDegreesToTurn()

      • getIdleAnimation

        public int getIdleAnimation()

      • getLightModifier

        public int getLightModifier()

      • getWidthScale

        public int getWidthScale()

      • getHeightScale

        public int getHeightScale()

      • getVarpID

        public int getVarpID()

      • getShadowModifier

        public int getShadowModifier()

      • getTurn180Animation

        public int getTurn180Animation()

      • getTurn90CCWAnimation

        public int getTurn90CCWAnimation()

      • getTurn90CWAnimation

        public int getTurn90CWAnimation()

      • isClickable

        public boolean isClickable()

      • hasRenderPriority

        public boolean hasRenderPriority()

      • getTrueTile

        public Tile getTrueTile()
        Gets the tile that loot will drop on, adjusts NPC tile based on NPC size. Does not work for NPC's that don't drop loot on their own tiles (like Zulrah)
        Returns:
        True Tile of the NPC, the tile where loot would drop from the npc

      • getOverheadIcons

        @Deprecated
public int[] getOverheadIcons()
        Deprecated.

      • getOverheadIconSpriteIndex

        @Deprecated
public short[] getOverheadIconSpriteIndex()
        Deprecated.

      • getCurrentOverheadIcons

        public int[] getCurrentOverheadIcons()
        Returns the overhead icon archive IDs for the currently available overhead icon
        Returns:
        int[] of archive id's, including -1's, if icon available. Else null if no icon available.

      • getCurrentOverheadSpriteIndices

        public short[] getCurrentOverheadSpriteIndices()
        Returns the overhead icon sprite indices for the currently available overhead icon
        Returns:
        short[] of sprite indices's, including -1's, if icon available. Else null if no icon available.

      • getModelOverride

        public NpcOverride getModelOverride()
        Returns the NPC's model override, contains model overriding data

      • getChatHeadModelOverride

        public NpcOverride getChatHeadModelOverride()
        Returns the NPC's chathead model override, contains model overriding data

      • exists

        public boolean exists()
        Description copied from class: Character
        Determines where or not this object exists in game.
        Specified by:
        exists in interface Verified
        Overrides:
        exists in class Character
        Returns:
        true, if the object exist, otherwise false.