Package com.valhalla.sdk.api.entities

Class Player

java.lang.Object

com.valhalla.sdk.api.entities.Player

All Implemented Interfaces:

Indexed, Locatable, Nameable

public final class Player
extends Object
implements Locatable, Indexed, Nameable

Immutable snapshot of one player from the current native world view.

Constructor Summary

Constructors

Constructor	Description
Player(int index, String name, Tile tile, boolean moving, boolean local)	Creates a player snapshot without decoded route steps.
Player(int index, String name, Tile tile, boolean moving, boolean local, List<Tile> walkingQueue)	Creates a player snapshot with a defensive copy of its walking queue.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object value)
int	getIndex()	Returns the current scene index.
String	getName()	Returns the captured display name.
Optional<Tile>	getNextStep()	Returns the first queued step that differs from the current tile.
Tile	getTile()	Returns the captured world location.
Optional<Tile>	getWalkingDestination()	Returns the final queued destination when it differs from the current tile.
List<Tile>	getWalkingQueue()	Returns the captured walking queue.
int	hashCode()
boolean	isLocal()	Reports whether this is the local player.
boolean	isMoving()	Returns the captured movement state.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.valhalla.sdk.api.entities.Locatable

canReach, canReach, distance, distanceTo, getGridX, getGridY, getPlane, getRegionId, getX, getY, getZ, isInArea, isWithinDistance, walkingDistance

Methods inherited from interface com.valhalla.sdk.api.entities.Nameable

hasName

Constructor Details

Player

public Player(int index,
 String name,
 Tile tile,
 boolean moving,
 boolean local)

Creates a player snapshot without decoded route steps.

Parameters:

index - current scene index

name - captured display name, possibly blank

tile - current world tile

moving - whether the native client reported movement

local - whether this snapshot represents the local player

Player

public Player(int index,
 String name,
 Tile tile,
 boolean moving,
 boolean local,
 List<Tile> walkingQueue)

Creates a player snapshot with a defensive copy of its walking queue.

Parameters:

index - current scene index

name - captured display name, possibly blank

tile - current world tile

moving - whether the native client reported movement

local - whether this snapshot represents the local player

walkingQueue - ordered route steps captured from the client

Method Details

getIndex

public int getIndex()

Returns the current scene index.

Specified by:

getIndex in interface Indexed

Returns:

current scene index

getName

public String getName()

Returns the captured display name.

Specified by:

getName in interface Nameable

Returns:

captured display name, possibly blank

getTile

public Tile getTile()

Returns the captured world location.

Specified by:

getTile in interface Locatable

Returns:

current world tile captured in this snapshot

isMoving

public boolean isMoving()

Returns the captured movement state.

Returns:

whether movement was active when this snapshot was captured

isLocal

public boolean isLocal()

Reports whether this is the local player.

Returns:

whether this snapshot represents the local player

getWalkingQueue

public List<Tile> getWalkingQueue()

Returns the captured walking queue.

Returns:

immutable ordered walking queue captured from the client

getWalkingDestination

public Optional<Tile> getWalkingDestination()

Returns the final queued destination when it differs from the current tile.

Returns:

destination, or empty when no meaningful route is queued

getNextStep

public Optional<Tile> getNextStep()

Returns the first queued step that differs from the current tile.

Returns:

next route step, or empty when none remains

equals

public boolean equals(Object value)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object