script-sdk/org.tribot.script.sdk.interfaces/Character

Character

interface Character : Modellable, Named, Interactable, Indexable, Orientable

Represents a player or npc entity

Types

WalkingDirection

enum WalkingDirection

Functions

adjustCameraTo

abstract fun adjustCameraTo(): Boolean

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

click

abstract fun click(): Boolean

Interacts with the entity, with the first action available.

abstract 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

getAnimation

abstract fun getAnimation(): Int

Gets the character's current animation

getCombatLevel

abstract fun getCombatLevel(): Int

Gets the combat level of the character.

getEffects

abstract fun getEffects(): List<Integer>

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

getHealthBarPercent

abstract fun getHealthBarPercent(): Double

Gets the current percent of the health bar that is green

getHitsplats

abstract fun getHitsplats(): List<Hitsplat>

Gets the hitsplats currently displayed on this character

getIndex

abstract fun getIndex(): Int

Gets the index of the entity.

getInteractingCharacter

abstract fun getInteractingCharacter(): Optional<Character>

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

getModel

abstract fun getModel(): Optional<Model>

Gets the entity model

getName

abstract fun getName(): String

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

getNextTile

abstract fun getNextTile(): Optional<Tile>

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

getOrientation

abstract fun getOrientation(): Orientable.Orientation

Gets the orientation of this entity

getOverheadIcon

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

getOverheadMessage

abstract fun getOverheadMessage(): String

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

getTile

abstract fun getTile(): WorldTile

Gets the WorldTile of this entity/position

getWalkingDirection

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

Gets the direction this character is walking

hasHintArrow

abstract fun hasHintArrow(): Boolean

Determines if a hint arrow is pointing to this character.

hover

abstract fun hover(): Boolean

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

open fun hover(action: String): Boolean

Hovers the specified action on this 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

abstract fun isFacing(position: Positionable): Boolean

Determines if this character is facing a given position.

isHealthBarVisible

abstract 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

abstract fun isInteracting(): Boolean

Determines if this character is interacting with any another character.

isInteractingWithMe

abstract fun isInteractingWithMe(): Boolean

Determines if this character is interacting with the player.

isMoving

abstract fun isMoving(): Boolean

Determines if the character is moving or not.

isVisible

abstract fun isVisible(): Boolean

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