Character

public interface Character implements Modellable, Named, Interactable, Indexable, Orientable

Represents a player or npc entity

Types

WalkingDirection

public enum WalkingDirection

Functions

adjustCameraTo

abstract boolean adjustCameraTo()

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

click

abstract boolean click()

Interacts with the entity, with the first action available.

abstract 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

getAnimation

abstract int getAnimation()

Gets the character's current animation

getCombatLevel

abstract int getCombatLevel()

Gets the combat level of the character.

getEffects

abstract List<Integer> getEffects()

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

getHealthBarPercent

abstract double getHealthBarPercent()

Gets the current percent of the health bar that is green

getHitsplats

abstract List<Hitsplat> getHitsplats()

Gets the hitsplats currently displayed on this character

getIndex

abstract int getIndex()

Gets the index of the entity.

getInteractingCharacter

abstract Optional<Character> getInteractingCharacter()

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

getModel

abstract Optional<Model> getModel()

Gets the entity model

getName

abstract String getName()

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

getNextTile

abstract Optional<Tile> getNextTile()

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

getOrientation

abstract Orientable.Orientation getOrientation()

Gets the orientation of this entity

getOverheadIcon

abstract Optional<Player.OverheadIcon> getOverheadIcon()

getOverheadMessage

abstract String getOverheadMessage()

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

getTile

abstract WorldTile getTile()

Gets the WorldTile of this entity/position

getWalkingDirection

abstract Optional<Character.WalkingDirection> getWalkingDirection()

Gets the direction this character is walking

hover

abstract 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

abstract boolean isFacing(Positionable position)

Determines if this character is facing a given position.

isHealthBarVisible

abstract 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

abstract boolean isInteracting()

Determines if this character is interacting with any another character.

isInteractingWithMe

abstract boolean isInteractingWithMe()

Determines if this character is interacting with the player.

isMoving

abstract boolean isMoving()

Determines if the character is moving or not.

isVisible

abstract boolean isVisible()

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