Package dev.twilite.game.wrapper

Class HintArrow

java.lang.Object

dev.twilite.game.wrapper.HintArrow

All Implemented Interfaces:

Unit

public class HintArrow
extends Object
implements Unit

Hint arrow marker, optionally targeting a unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TYPE_COORD
static final int	TYPE_NPC
static final int	TYPE_PLAYER
static final int	TYPE_WORLD_ENTITY

Constructor Summary

Constructors

Constructor	Description
HintArrow(dev.twilite.game.internal.memory.RSHintArrow memory, World world)	Wraps a native hint-arrow provider.

Method Summary

Modifier and Type	Method	Description
Rect	area()	Returns the area this unit occupies.
Coord	coord()	Returns this unit's world coordinate.
Coord.Fine	fine()	Returns this unit's fine coordinate, representing its model location.
Coord.Map	map()	Returns this unit's map coordinate relative to the loaded world area.
Optional<? extends Unit>	target()	Resolves the unit targeted by this hint arrow when it targets a unit type.
int	type()	Returns the hint-arrow target type.
World	world()	Returns the world this unit belongs to.

Methods inherited from class java.lang.Object

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

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

Field Details

TYPE_NPC

public static final int TYPE_NPC

See Also:

• Constant Field Values

TYPE_COORD

public static final int TYPE_COORD

See Also:

• Constant Field Values

TYPE_PLAYER

public static final int TYPE_PLAYER

See Also:

• Constant Field Values

TYPE_WORLD_ENTITY

public static final int TYPE_WORLD_ENTITY

See Also:

• Constant Field Values

Constructor Details

HintArrow

public HintArrow(dev.twilite.game.internal.memory.RSHintArrow memory,
 World world)

Wraps a native hint-arrow provider.

Method Details

target

public Optional<? extends Unit> target()

Resolves the unit targeted by this hint arrow when it targets a unit type. This can be a Player, Npc or WorldEntity

type

public int type()

Returns the hint-arrow target type.

world

public World world()

Description copied from interface: Unit

Returns the world this unit belongs to.

Specified by:

world in interface Unit

area

public Rect area()

Description copied from interface: Unit

Returns the area this unit occupies.

Specified by:

area in interface Unit

coord

public Coord coord()

Description copied from interface: Unit

Returns this unit's world coordinate.

Specified by:

coord in interface Unit

fine

public Coord.Fine fine()

Description copied from interface: Unit

Returns this unit's fine coordinate, representing its model location.

Specified by:

fine in interface Unit

map

public Coord.Map map()

Description copied from interface: Unit

Returns this unit's map coordinate relative to the loaded world area.

Specified by:

map in interface Unit