Package io.github.emcw.map.entities

Class Player

java.lang.Object

io.github.emcw.map.entities.BaseEntity<Player>

io.github.emcw.map.entities.Player

All Implemented Interfaces:

ILocatable<Player>, ISerializable

Direct Known Subclasses:

Resident

public class Player
extends BaseEntity<Player>
implements ISerializable, ILocatable<Player>

Field Summary

Fields inherited from interface io.github.emcw.interfaces.ILocatable

INT_ARRAY_X, INT_ARRAY_Z

Constructor Summary

Constructors

Constructor	Description
Player(@NotNull Player player)
Player(com.google.gson.JsonObject obj)
Player(com.google.gson.JsonObject obj, Boolean resident)
Player(com.google.gson.JsonObject obj, Boolean resident, Boolean parsed)

Method Summary

Modifier and Type	Method	Description
boolean	hasCustomNickname()	If this player has set a nickname.
boolean	hidden()	Essentially the opposite of visible().
boolean	isResident()	Check if this player is also a resident on the map this instance was retrieved from.
boolean	locationIsDefault()	Whether this player is located at the default map location.
void	setLocation(com.google.gson.JsonObject obj, @NotNull Boolean parsed)
boolean	visible()	If this player is visible on the Dynmap.

Methods inherited from class io.github.emcw.map.entities.BaseEntity

setInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.emcw.interfaces.ILocatable

getNearby, getNearby

Methods inherited from interface io.github.emcw.interfaces.ISerializable

asString

Constructor Details

Player

public Player(com.google.gson.JsonObject obj)

Player

public Player(com.google.gson.JsonObject obj,
 Boolean resident)

Player

public Player(com.google.gson.JsonObject obj,
 Boolean resident,
 Boolean parsed)

Player

public Player(@NotNull
 @NotNull Player player)

Method Details

setLocation

public void setLocation(com.google.gson.JsonObject obj,
 @NotNull
 @NotNull Boolean parsed)

hasCustomNickname

public boolean hasCustomNickname()

If this player has set a nickname.

Returns:

true/false if nickname is same as their account BaseEntity.name.

visible

public boolean visible()

If this player is visible on the Dynmap.

Returns:

true/false if world is "earth" and player is not under a block.

hidden

public boolean hidden()

Essentially the opposite of visible().

NOTE: This returns true for players under a tree, in the nether etc.

Returns:

true/false if world is NOT "earth" and location is 0, 64, 0.

locationIsDefault

public boolean locationIsDefault()

Whether this player is located at the default map location.

Returns:

true/false if location is 0, 0

isResident

public boolean isResident()

Check if this player is also a resident on the map this instance was retrieved from.