Interface Player
-
- All Superinterfaces:
Actor
,Animable
,Interactable
,Locatable
,LocatableEntity
,Modeled
,Onymous
,Renderable
,Rotatable
,Validatable
- All Known Implementing Classes:
OSRSPlayer
public interface Player extends Actor
A real-player's avatar
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description CombatGauge
getAdrenalineGauge()
Gets the adrenaline gauge that's available during combatlong
getAppearanceHash()
int
getCombatLevel()
Gets the combat level of this player@NonNull java.util.List<ItemDefinition>
getEquipment()
Deprecated.SummonedFamiliar
getFamiliar()
An RS3 exclusive that gets the currently summoned familiar.default int
getNpcId()
Deprecated.int
getNpcTransformationId()
The id of this players alternative, npc-based form.int
getTeamId()
default java.lang.String
getTitlePostfix()
Deprecated.java.lang.String
getTitlePrefix()
Deprecated.java.lang.String
getTitleSuffix()
Deprecated.int
getTotalLevel()
The total skill level of this player.int
getWildernessDepth()
The level of the wilderness this player is in (RS3 only)ItemDefinition
getWornItem(Equipment.Slot slot)
@NonNull java.util.List<ItemDefinition>
getWornItems()
boolean
isFemale()
Whether or not the player is female-
Methods inherited from interface com.runemate.game.api.hybrid.entities.Actor
getAnimationFrame, getDialogue, getHealthGauge, getHitsplats, getOverheadIcons, getPath, getServerPosition, getSpotAnimationIds, getStanceFrame, getStanceId, getTarget, isMoving
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Animable
getAnimationId
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Interactable
click, contains, getInteractionPoint, getInteractionPoint, getVisibility, hasDynamicBounds, hover, interact, interact, interact, interact, interact, interact, isHovered, isVisible
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Locatable
distanceTo, distanceTo, getLocalPosition
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.LocatableEntity
getArea, getArea, getHighPrecisionPosition, getHighPrecisionPosition, getPosition, getPosition
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Modeled
getModel, setBackupModel, setBackupModel, setBackupModel, setForcedModel, setForcedModel, setForcedModel
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Renderable
render, render
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Rotatable
getHighPrecisionOrientation, getOrientationAsAngle, isFacing
-
Methods inherited from interface com.runemate.game.api.hybrid.util.Validatable
isValid
-
-
-
-
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.
-
getNpcId
@Deprecated default int getNpcId()
Deprecated.- See Also:
getNpcTransformationId()
-
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()
-
getWornItem
@Nullable ItemDefinition getWornItem(Equipment.Slot slot)
-
getTeamId
int getTeamId()
-
getAppearanceHash
@OSRSOnly long getAppearanceHash()
-
-