script-sdk/org.tribot.script.sdk.types/Player

Player

open class Player : AbstractCharacter

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

Constructors

Player

constructor(player: RSPlayer)

Types

OverheadIcon

enum OverheadIcon

SkullIcon

enum SkullIcon

Functions

adjustCameraTo

open fun adjustCameraTo(): Boolean

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

click

open fun click(): Boolean

Interacts with the entity, with the first action available.

open fun click(action: String): Boolean

Interacts with the entity, given a specific action.

distance

open fun distance(): Int

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

distanceTo

open fun distanceTo(position: Positionable): Int

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

equals

open fun equals(o: Any): Boolean

getAnimation

open fun getAnimation(): Int

Gets the character's current animation

getCombatLevel

open fun getCombatLevel(): Int

Gets the combat level of the character.

getEffects

open fun getEffects(): List<Integer>

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

getEquipment

open fun getEquipment(): List<Item>

Gets the player's equipped items.

getEquippedItem

open fun getEquippedItem(slot: Equipment.Slot): Optional<Item>

Gets the item equipped in the specific slot.

getHealthBarPercent

open fun getHealthBarPercent(): Double

Gets the current percent of the health bar that is green

getHitsplats

open fun getHitsplats(): List<Hitsplat>

Gets the hitsplats currently displayed on this character

getIndex

open fun getIndex(): Int

Gets the index of the entity.

getInteractingCharacter

open fun getInteractingCharacter(): Optional<Character>

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

getLegacyRSPlayer

open fun getLegacyRSPlayer(): RSPlayer

getModel

open fun getModel(): Optional<Model>

Gets the entity model

getName

open fun getName(): String

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

getNextTile

open fun getNextTile(): Optional<Tile>

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

getOrientation

open fun getOrientation(): Orientable.Orientation

Gets the orientation of this entity

getOverheadIcon

open fun getOverheadIcon(): Optional<Player.OverheadIcon>

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

getOverheadMessage

open fun getOverheadMessage(): String

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

getSkullIcon

open fun getSkullIcon(): Optional<Player.SkullIcon>

Gets the skull icon above this player

getSpotAnimation

open fun getSpotAnimation(): Int

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

getTile

open fun getTile(): WorldTile

Gets the WorldTile of this entity/position

getWalkingDirection

open fun getWalkingDirection(): Optional<Character.WalkingDirection>

Gets the direction this character is walking

hashCode

open fun hashCode(): Int

hasHintArrow

open fun hasHintArrow(): Boolean

Determines if a hint arrow is pointing to this character.

hover

open fun hover(action: String): Boolean

Hovers the specified action on this entity.

open fun hover(): Boolean

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

hoverMenu

open fun hoverMenu(action: String): Boolean

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

interact

open fun interact(action: String): Boolean

open fun interact(action: String, interruptCondition: BooleanSupplier): Boolean

Attempts to interact with the entity using the given action.

isAnimating

open fun isAnimating(): Boolean

Checks if the character is currently animating

isFacing

open fun isFacing(position: Positionable): Boolean

Determines if this character is facing a given position.

isHealthBarVisible

open fun isHealthBarVisible(): Boolean

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

isHovering

open fun isHovering(): Boolean

Checks if the mouse is currently over this entity

isInteracting

open fun isInteracting(): Boolean

Determines if this character is interacting with any another character.

isInteractingWithMe

open fun isInteractingWithMe(): Boolean

Determines if this character is interacting with the player.

isInteractingWithObject

open fun isInteractingWithObject(object: GameObject): Boolean

Determines if an object is being interacted with by the player

isMoving

open fun isMoving(): Boolean

Determines if the character is moving or not.

isVisible

open fun isVisible(): Boolean

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

lookupStats

open fun lookupStats(): Optional<Hiscores.Player>

Gets the stats of this player by checking the highscores.

toString

open fun toString(): String

Player

See also

Constructors

Types

Functions