Interface Player

    • Method Detail

      • getAdrenalineGauge

        @RS3Only
        @Nullable
        CombatGauge getAdrenalineGauge()
        Gets the adrenaline gauge that's available during combat
        Returns:
        The adrenaline gauge when in combat, otherwise null
      • getCombatLevel

        int getCombatLevel()
        Gets the combat level of this player
        Returns:
        the combat level, otherwise -1
      • getFamiliar

        @RS3Only
        @Nullable
        SummonedFamiliar getFamiliar()
        An RS3 exclusive that gets the currently summoned familiar.
      • getNpcTransformationId

        int getNpcTransformationId()
        The id of this players alternative, npc-based form. Typically available when a player is transformed such as when a monkey at Ape Atoll.
      • getTitlePostfix

        @RS3Only
        @Deprecated
        default java.lang.String getTitlePostfix()
        Deprecated.
        See Also:
        getTitleSuffix()
      • getTitlePrefix

        @RS3Only
        @Nullable
        @Deprecated
        java.lang.String getTitlePrefix()
        Deprecated.
        Gets this players title (when prefixed) (i.e. Lord, King)(RS3 only)
      • getTitleSuffix

        @RS3Only
        @Nullable
        @Deprecated
        java.lang.String getTitleSuffix()
        Deprecated.
        Gets this players title (when suffixed) (RS3 only)
      • getTotalLevel

        int getTotalLevel()
        The total skill level of this player.
        Returns:
        0 if your weapon is unsheathed on RS3 and 0 if some unknown condition is fufilled on OSRS, otherwise the total level of the player
      • getWildernessDepth

        @RS3Only
        int getWildernessDepth()
        The level of the wilderness this player is in (RS3 only)
      • isFemale

        boolean isFemale()
        Whether or not the player is female
        Returns:
        True if female, otherwise false
      • getEquipment

        @Deprecated
        @NonNull
        @NonNull java.util.List<ItemDefinition> getEquipment()
        Deprecated.
      • getWornItems

        @NonNull
        @NonNull java.util.List<ItemDefinition> getWornItems()
      • getTeamId

        int getTeamId()
      • getAppearanceHash

        @OSRSOnly
        long getAppearanceHash()