Package net.okocraft.box.api.player

Interface BoxPlayer

public interface BoxPlayer

An interface of the online user.

Method Summary

Modifier and Type	Method	Description
@NotNull BoxUser	asUser()	Returns BoxUser that created from getUUID() and getName().
@NotNull StockHolder	getCurrentStockHolder()	Gets the current StockHolder to deposit or withdraw.
@NotNull String	getName()	Gets the name of this user.
@NotNull PersonalStockHolder	getPersonalStockHolder()	Gets the personal StockHolder of this player.
@NotNull Player	getPlayer()	Gets the Player instance.
@NotNull UUID	getUUID()	Gets the UUID of this user.
void	setCurrentStockHolder(@NotNull StockHolder stockHolder)	Sets the StockHolder to deposit or withdraw.

Method Details

getUUID

@NotNull
@NotNull UUID getUUID()

Gets the UUID of this user.

Returns:

the UUID of this user

getName

@NotNull
@NotNull String getName()

Gets the name of this user.

Returns:

the name of this user

asUser

@NotNull
@NotNull BoxUser asUser()

Returns BoxUser that created from getUUID() and getName().

Returns:

a BoxUser created from getUUID() and getName()

getPlayer

@NotNull
@NotNull Player getPlayer()

Gets the Player instance.

Returns:

the Player

getPersonalStockHolder

@NotNull
@NotNull PersonalStockHolder getPersonalStockHolder()

Gets the personal StockHolder of this player.

Returns:

the personal StockHolder of this player

getCurrentStockHolder

@NotNull
@NotNull StockHolder getCurrentStockHolder()

Gets the current StockHolder to deposit or withdraw.

Returns:

the current StockHolder

setCurrentStockHolder

void setCurrentStockHolder(@NotNull
 @NotNull StockHolder stockHolder)

Sets the StockHolder to deposit or withdraw.

Parameters:

stockHolder - the StockHolder