Player

public class Player extends AbstractCharacter

Represents a player (such as yourself, or another player)

Constructors

Player

void Player(RSPlayer player)

Types

OverheadIcon

public enum OverheadIcon

SkullIcon

public enum SkullIcon

Functions

adjustCameraTo

boolean adjustCameraTo()

Moves the camera to a position where the given entity or position is in view.

click

boolean click()

Interacts with the entity, with the first action available.

boolean click(String action)

Interacts with the entity, given a specific action.

distance

int distance()

Determines the distance between this entity/tile and the local player

distanceTo

int distanceTo(Positionable position)

Determines the distance between this entity/tile and the given entity/tile

equals

boolean equals(Object o)

getAnimation

int getAnimation()

Gets the character's current animation

getCombatLevel

int getCombatLevel()

Gets the combat level of the character.

getEffects

List<Integer> getEffects()

Gets the IDs representing the current effects applied to the player, or empty if none exist.

getEquipment

List<Item> getEquipment()

Gets the player's equipped items.

getEquippedItem

Optional<Item> getEquippedItem(Equipment.Slot slot)

Gets the item equipped in the specific slot.

getHealthBarPercent

double getHealthBarPercent()

Gets the current percent of the health bar that is green

getHitsplats

List<Hitsplat> getHitsplats()

Gets the hitsplats currently displayed on this character

getIndex

int getIndex()

Gets the index of the entity.

getInteractingCharacter

Optional<Character> getInteractingCharacter()

Gets the Character that this character is interacting with (attacking, following, etc).

getLegacyRSPlayer

RSPlayer getLegacyRSPlayer()

getModel

Optional<Model> getModel()

Gets the entity model

getName

String getName()

Determines the name of the entity of the object this method is called on.

getNextTile

Optional<Tile> getNextTile()

Gets the next tile this character will be at, if it is moving

getOrientation

Orientable.Orientation getOrientation()

Gets the orientation of this entity

getOverheadIcon

Optional<Player.OverheadIcon> getOverheadIcon()

Gets the overhead icon on this player, such as protect from melee

getOverheadMessage

String getOverheadMessage()

Gets the message displayed above this character, such as a public chat message

getSkullIcon

Optional<Player.SkullIcon> getSkullIcon()

Gets the skull icon above this player

getSpotAnimation

int getSpotAnimation()

Gets the ID representing the current spot animation of the player, or -1 if the player is not performing a spot animation.

getTile

WorldTile getTile()

Gets the WorldTile of this entity/position

getWalkingDirection

Optional<Character.WalkingDirection> getWalkingDirection()

Gets the direction this character is walking

hashCode

int hashCode()

hover

boolean hover()

Moves the mouse to a human-randomized point on the entity.

boolean hover(String action)

Hovers the specified action on this entity.

hoverMenu

boolean hoverMenu(String action)

Hovers the specified action on this entity, always right-clicking and hovering over the menu

interact

boolean interact(String action)

Attempts to interact with the entity using the given action.

boolean interact(String action, BooleanSupplier interruptCondition)

Attempts to interact with the entity using the given action.

isAnimating

boolean isAnimating()

Checks if the character is currently animating

isFacing

boolean isFacing(Positionable position)

Determines if this character is facing a given position.

isHealthBarVisible

boolean isHealthBarVisible()

Determines if the health bar interface is appearing over this character's head.

isHovering

boolean isHovering()

Checks if the mouse is currently over this entity

isInteracting

boolean isInteracting()

Determines if this character is interacting with any another character.

isInteractingWithMe

boolean isInteractingWithMe()

Determines if this character is interacting with the player.

isInteractingWithObject

boolean isInteractingWithObject(GameObject object)

Determines if an object is being interacted with by the player

isMoving

boolean isMoving()

Determines if the character is moving or not.

isVisible

boolean isVisible()

Determines if the entity is on the screen and able to be clicked.

lookupStats

Optional<Hiscores.Player> lookupStats()

Gets the stats of this player by checking the highscores.

toString

String toString()

Player

See also

Constructors

Types

Functions