Package dev.twilite.game.wrapper

Class Player

java.lang.Object

dev.twilite.game.wrapper.Actor<dev.twilite.game.internal.memory.RSPlayer>

dev.twilite.game.wrapper.Player

All Implemented Interfaces:

Interactable, InteractableUnit, Unit

public class Player
extends Actor<dev.twilite.game.internal.memory.RSPlayer>

Player actor wrapper.

Method Summary

Modifier and Type	Method	Description
int	kit(KitType type)	Returns this player's appearance identikit id at type, -1 when unavailable or -2 when it is not an item.
String	name()	Returns the standardized player name.
List<MenuOption>	options()	Returns known player menu options.
int	prayer()	Returns this player's prayer overhead icon id.
boolean	select()	Enqueues the selected-use-on-player action.
int	skull()	Returns this player's skull icon id.
boolean	target()	Enqueues the selected-target-on-player action.

Methods inherited from class dev.twilite.game.wrapper.Actor

animating, animation, area, coord, dying, effects, equals, faceUnit, facingUnit, facingUnit, fine, headbarPercent, headbarRendered, headbars, headMessage, healthPercent, healthRendered, hitmarks, index, map, moving, orientation, stance, world

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.twilite.game.trait.Interactable

interact, option

Methods inherited from interface dev.twilite.game.trait.Unit

directPathTo, directPathTo, directPathTo, distanceTo, distanceTo, distanceTo, lineOfSightTo, lineOfSightTo, lineOfSightTo, lineOfWalkTo, lineOfWalkTo, lineOfWalkTo, manhattanDistanceTo, manhattanDistanceTo, manhattanDistanceTo, pathInDirection

Method Details

name

public String name()

Returns the standardized player name. Standardized text is tag-stripped, trimmed, and lowercased.

Specified by:

name in class Actor<dev.twilite.game.internal.memory.RSPlayer>

kit

public int kit(KitType type)

Returns this player's appearance identikit id at type, -1 when unavailable or -2 when it is not an item. If it is an item, this will correspond to a constant from ItemId

skull

public int skull()

Returns this player's skull icon id.

prayer

public int prayer()

Returns this player's prayer overhead icon id.

options

public List<MenuOption> options()

Returns known player menu options.

target

public boolean target()

Enqueues the selected-target-on-player action.

select

public boolean select()

Enqueues the selected-use-on-player action.