Package com.runemate.game.api.hybrid.entities.definitions

Class NpcDefinition

    • Constructor Detail

      • NpcDefinition

        public NpcDefinition()

    • Method Detail

      • get

        public static java.util.List<NpcDefinition> get​(int first,
                                                int last)
        Gets a list of definitions within the range of [first, last]

      • get

        public static java.util.List<NpcDefinition> get​(int first,
                                                int last,
                                                java.util.function.Predicate<NpcDefinition> filter)
        Gets a list of definitions within the range of [first, last] that are accepted by the filter

      • get

        @Nullable
public static NpcDefinition get​(int id)
        Gets the NpcDefinition for the npc with the specified id
        Returns:
        The definition if available, otherwise null

      • getName

        @NonNull
public abstract @NonNull java.lang.String getName()
        Specified by:
        getName in interface Onymous

      • getOverheadGaugeWidth

        public abstract int getOverheadGaugeWidth()

      • appearsOnMinimap

        public abstract boolean appearsOnMinimap()

      • getActions

        @NonNull
public abstract @NonNull java.util.List<java.lang.String> getActions()
        Gets the powers of this npc

      • getRawActions

        @Nullable
public abstract java.lang.String[] getRawActions()

      • getAppearance

        @NonNull
public abstract @NonNull java.util.List<java.lang.Integer> getAppearance()
        Gets a list of integers that are used to represent this entities appearance. Internally these are used to generate an Npc's Model.

      • getChatHeadAppearance

        @NonNull
public abstract @NonNull java.util.List<java.lang.Integer> getChatHeadAppearance()

      • getAttribute

        public abstract Attribute getAttribute​(long id)

      • getAttributes

        @NonNull
public abstract @NonNull java.util.List<Attribute> getAttributes()

      • getColorSubstitutions

        @NonNull
public abstract @NonNull java.util.Map<java.awt.Color,​java.awt.Color> getColorSubstitutions()
        Gets a mapping of colors that are to be substituted in the base model.

      • getId

        public abstract int getId()
        An id that can be used to identify this npc
        Specified by:
        getId in interface Identifiable

      • getLevel

        public abstract int getLevel()
        Gets this npc's level

      • getLocalState

        @Nullable
public abstract NpcDefinition getLocalState()

      • getMaterialSubstitutions

        @NonNull
public abstract @NonNull java.util.Map<Material,​Material> getMaterialSubstitutions()

      • getMovementCapabilitiesFlag

        public abstract int getMovementCapabilitiesFlag()

      • getOverheadIcons

        @NonNull
public abstract @NonNull java.util.List<OverheadIcon> getOverheadIcons()
        The icons above this npc
        Returns:
        a list of overhead icons

      • getTransformations

        @NonNull
public abstract @NonNull java.util.Collection<NpcDefinition> getTransformations()

      • hasPrioritizedRendering

        public abstract boolean hasPrioritizedRendering()

      • isClickable

        public abstract boolean isClickable()
        Gets whether or not the npc with this definition can be interacted with.

      • isFollower

        public abstract boolean isFollower()

      • toString

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

      • getAreaEdgeLength

        public abstract int getAreaEdgeLength()

      • getStateVarp

        @Nullable
public abstract Varp getStateVarp()
        The Varp responsible for controlling the state (NpcDefinition) of the Npc, if present.

      • getStateVarbit

        @Nullable
public abstract Varbit getStateVarbit()
        The Varbit responsible for controlling the state (NpcDefinition) of the Npc, if present.