Class WrappedPlayer

java.lang.Object

nl.pim16aap2.animatedarchitecture.spigot.util.implementations.WrappedPlayer

All Implemented Interfaces:

IMessageable, IPlayer, ICommandSender

public final class WrappedPlayer
extends Object
implements IPlayer

Represents an implementation of IPlayer for the Spigot platform.

Constructor Summary

Constructors

Constructor	Description
WrappedPlayer(org.bukkit.entity.Player spigotPlayer, ILocalizer localizer, ITextFactory textFactory)	Deprecated. Use IPlayerFactory instead.

Method Summary

Modifier and Type	Method	Description
default String	asString()	Gets the player as a String in the format '"playerName" (playerUUID)'.
boolean	equals(@Nullable Object o)
org.bukkit.entity.Player	getBukkitPlayer()	Gets the bukkit player represented by this IPlayer
OptionalInt	getLimit(Limit limit)
Optional<ILocation>	getLocation()	Gets the current location of this player.
String	getName()
default long	getPermissionsFlag()
PersonalizedLocalizer	getPersonalizedLocalizer()	Creates a new PersonalizedLocalizer using the localizer and locale of this messageable.
default PlayerData	getPlayerData()	Gets a the PlayerData that represents this player.
ITextFactory	getTextFactory()	Gets the text factory of this messageable.
UUID	getUUID()
int	hashCode()
CompletableFuture<Boolean>	hasPermission(String permission)	Checks if this sender has a given permission.
CompletableFuture<PermissionsStatus>	hasPermission(CommandDefinition command)	Checks if this sender has a given command.
boolean	hasProtectionBypassPermission()
boolean	isOnline()	Returns whether this player is online.
boolean	isOp()
void	sendMessage(Text text)	Sends a message to this object.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface IMessageable

newText, sendError, sendInfo, sendMessage, sendSuccess

Methods inherited from interface IPlayer

formatCommand, getPlayer, isPlayer

Constructor Details

WrappedPlayer

@Deprecated
public WrappedPlayer(org.bukkit.entity.Player spigotPlayer,
 ILocalizer localizer,
 ITextFactory textFactory)

Deprecated.

Use IPlayerFactory instead.

Creates a new WrappedPlayer object.

Parameters:

spigotPlayer - The Spigot player to wrap.

localizer - The localizer to use for localization of messages to send to the player.

textFactory - The text factory to use for creating text objects.

Method Details

getUUID

public UUID getUUID()

hasProtectionBypassPermission

public boolean hasProtectionBypassPermission()

getLocation

public Optional<ILocation> getLocation()

Description copied from interface: IPlayer

Gets the current location of this player.

Specified by:

getLocation in interface IPlayer

Returns:

The current location of this player.

hasPermission

public CompletableFuture<Boolean> hasPermission(String permission)

Description copied from interface: ICommandSender

Checks if this sender has a given permission.

Specified by:

hasPermission in interface ICommandSender

Specified by:

hasPermission in interface IPlayer

Parameters:

permission - The permission node to check.

Returns:

True if the player has access to the provided permission, otherwise false.

hasPermission

public CompletableFuture<PermissionsStatus> hasPermission(CommandDefinition command)

Description copied from interface: ICommandSender

Checks if this sender has a given command.

Both the user permission (See CommandDefinition.getUserPermission()) and the admin permission (See CommandDefinition.getAdminPermission()) are checked.

Specified by:

hasPermission in interface ICommandSender

Specified by:

hasPermission in interface IPlayer

Parameters:

command - The CommandDefinition of a command to check.

Returns:

A PermissionsStatus that is true if the player has access to the provided permissions, otherwise false for the user and the admin permission nodes respectively.

isOnline

public boolean isOnline()

Description copied from interface: IPlayer

Returns whether this player is online.

Specified by:

isOnline in interface IPlayer

Returns:

True if this player is online.

getLimit

public OptionalInt getLimit(Limit limit)

isOp

public boolean isOp()

getName

public String getName()

sendMessage

public void sendMessage(Text text)

Description copied from interface: IMessageable

Sends a message to this object.

Specified by:

sendMessage in interface IMessageable

Parameters:

text - The message to send. This may or may not contain formatting.

getBukkitPlayer

public org.bukkit.entity.Player getBukkitPlayer()

Gets the bukkit player represented by this IPlayer

Returns:

The Bukkit player.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTextFactory

public ITextFactory getTextFactory()

Description copied from interface: IMessageable

Gets the text factory of this messageable.

Specified by:

getTextFactory in interface IMessageable

Returns:

The text factory of this messageable.

getPersonalizedLocalizer

public PersonalizedLocalizer getPersonalizedLocalizer()

Description copied from interface: IMessageable

Creates a new PersonalizedLocalizer using the localizer and locale of this messageable.

Specified by:

getPersonalizedLocalizer in interface IMessageable

Returns:

A new PersonalizedLocalizer object.

asString

default String asString()

Gets the player as a String in the format '"playerName" (playerUUID)'.

Returns:

The player as a String.

getPlayerData

default PlayerData getPlayerData()

Gets a the PlayerData that represents this player. This may or may not be a new object.

Returns:

The PlayerData that represents this player.

getPermissionsFlag

default long getPermissionsFlag()