nova.core.entity.component

Class Player

java.lang.Object

nova.core.component.Component

nova.core.entity.component.Living

nova.core.entity.component.Player

All Implemented Interfaces:

Identifiable, UniqueIdentifiable

public abstract class Player
extends Living
implements UniqueIdentifiable

Basic representation of a Player.

Field Summary

Fields inherited from class nova.core.entity.component.Living

faceDisplacement

Constructor Summary

Constructors

Constructor and Description
Player()

Method Summary

Modifier and Type	Method and Description
abstract Entity	entity() Get the entity that represents this player.
java.lang.String	getDisplayName() Get the player's display name.
abstract InventoryPlayer	getInventory() Get the player's inventory.
abstract java.lang.String	getUniqueID() Get the unique ID for this player.
abstract java.lang.String	getUsername() Get the player's username.

Methods inherited from class nova.core.component.Component

getID, getProvider, onProviderChange

Methods inherited from class java.lang.Object

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

Methods inherited from interface nova.core.util.UniqueIdentifiable

getID

Methods inherited from interface nova.core.util.Identifiable

sameType

Constructor Detail

Player

public Player()

Method Detail

entity

public abstract Entity entity()

Get the entity that represents this player.

Returns:

The entity of the player

getUniqueID

public abstract java.lang.String getUniqueID()

Get the unique ID for this player. This ID is only unique in the context of the game in which the current NOVA instance is run.

No guarantees are made about cross-game ID uniqueness.

Specified by:

getUniqueID in interface UniqueIdentifiable

Returns:

Returns the unique ID representing the player

getInventory

public abstract InventoryPlayer getInventory()

Get the player's inventory.

Returns:

Inventory of the player

getUsername

public abstract java.lang.String getUsername()

Get the player's username.

The difference between this and getDisplayName() is that the name returned by this method is undecorated, while name returned by getDisplayName() may be decorated.

Returns:

Returns the undecorated non-identifying player name

getDisplayName

public java.lang.String getDisplayName()

Get the player's display name.

The difference between this and getUsername() is that the name returned by this method may be decorated, while getUsername() returns the undecorated name.

Returns:

Returns the decorated non-identifying player name