Package com.plotsquared.bukkit.player

Class BukkitPlayer

java.lang.Object

com.plotsquared.core.player.PlotPlayer<Player>

com.plotsquared.bukkit.player.BukkitPlayer

All Implemented Interfaces:

CommandCaller, LocaleHolder, PermissionHolder, OfflinePlotPlayer

public class BukkitPlayer
extends PlotPlayer<Player>

Nested Class Summary

Nested classes/interfaces inherited from class com.plotsquared.core.player.PlotPlayer

PlotPlayer.PlotPlayerConverter<BaseObject extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
final Player	player

Constructor Summary

Constructors

Constructor	Description
BukkitPlayer(@NonNull PlotAreaManager plotAreaManager, @NonNull EventDispatcher eventDispatcher, @NonNull Player player, boolean realPlayer, @NonNull PermissionHandler permissionHandler)	Deprecated, for removal: This API element is subject to removal in a future version. Please do not use this method.
BukkitPlayer(@NonNull PlotAreaManager plotAreaManager, @NonNull EventDispatcher eventDispatcher, @NonNull Player player, @NonNull PermissionHandler permissionHandler)	Deprecated, for removal: This API element is subject to removal in a future version. Please do not use this method.

Method Summary

Modifier and Type	Method	Description
boolean	canSee(PlotPlayer<?> other)
boolean	canTeleport(@NonNull Location location)
@NonNull Audience	getAudience()
boolean	getFlight()
com.sk89q.worldedit.world.gamemode.GameMode	getGameMode()
@org.checkerframework.checker.index.qual.NonNegative long	getLastPlayed()
Location	getLocationFull()
String	getName()
Player	getPlatformPlayer()
PlayerTeleportEvent.TeleportCause	getTeleportCause(@NonNull TeleportCause cause)	Convert from PlotSquared's TeleportCause to Bukkit's PlayerTeleportEvent.TeleportCause
@NonNull UUID	getUUID()
@org.checkerframework.checker.index.qual.NonNegative int	hasPermissionRange(@NonNull String stub, @org.checkerframework.checker.index.qual.NonNegative int range)
boolean	isBanned()
void	kick(String message)
void	playMusic(@NonNull Location location, @NonNull com.sk89q.worldedit.world.item.ItemType id)
void	removeEffect(@NonNull String name)
void	setCompassTarget(Location location)
void	setFlight(boolean fly)
void	setGameMode(com.sk89q.worldedit.world.gamemode.GameMode gameMode)
void	setTime(long time)
void	setWeather(@NonNull PlotWeather weather)
void	stopSpectating()
void	teleport(@NonNull Location location, @NonNull TeleportCause cause)
com.sk89q.worldedit.extension.platform.Actor	toActor()

Methods inherited from class com.plotsquared.core.player.PlotPlayer

accessPersistentMetaData, accessTemporaryMetaData, equals, from, getAllowedPlots, getApplicablePlotArea, getAttribute, getClusterCount, getClusterCount, getCurrentPlot, getDebugModePlayers, getDebugModePlayersInPlot, getLocale, getLocation, getLockRepository, getMeta, getPlayerClusterCount, getPlayerClusterCount, getPlotAreaAbs, getPlotCount, getPlotCount, getPlots, getPlots, getSuperCaller, hasDebugMode, hashCode, hasKeyedPermission, hasPermission, hasPermission, hasPermission, plotkick, populatePersistentMetaMap, refreshDebug, registerConverter, removeAttribute, sendActionBar, sendMessage, sendTitle, sendTitle, setAttribute, setLocale, setupPermissionProfile, teleport, toString, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plotsquared.core.permissions.PermissionHolder

hasKeyedPermission, hasPermission, hasPermission, hasPermissionRange

Field Details

player

public final Player player

Constructor Details

BukkitPlayer

@Deprecated(forRemoval=true,
            since="6.10.9")
public BukkitPlayer(@NonNull PlotAreaManager plotAreaManager,
 @NonNull EventDispatcher eventDispatcher,
 @NonNull Player player,
 @NonNull PermissionHandler permissionHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

Please do not use this method. Instead use BukkitUtil.adapt(Player), as it caches player objects. This method will be made private in a future release.

Parameters:

plotAreaManager - PlotAreaManager instance

eventDispatcher - EventDispatcher instance

player - Bukkit player instance

permissionHandler - PermissionHandler instance

BukkitPlayer

@Deprecated(forRemoval=true,
            since="6.10.9")
public BukkitPlayer(@NonNull PlotAreaManager plotAreaManager,
 @NonNull EventDispatcher eventDispatcher,
 @NonNull Player player,
 boolean realPlayer,
 @NonNull PermissionHandler permissionHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

Please do not use this method. Instead use BukkitUtil.adapt(Player), as it caches player objects. This method will be made private in a future release.

Parameters:

plotAreaManager - PlotAreaManager instance

eventDispatcher - EventDispatcher instance

player - Bukkit player instance

permissionHandler - PermissionHandler instance

Method Details

toActor

public com.sk89q.worldedit.extension.platform.Actor toActor()

Specified by:

toActor in class PlotPlayer<Player>

getPlatformPlayer

public Player getPlatformPlayer()

Specified by:

getPlatformPlayer in class PlotPlayer<Player>

getUUID

public @NonNull UUID getUUID()

Specified by:

getUUID in interface OfflinePlotPlayer

Specified by:

getUUID in class PlotPlayer<Player>

getLastPlayed

public @org.checkerframework.checker.index.qual.NonNegative long getLastPlayed()

canTeleport

public boolean canTeleport(@NonNull Location location)

Overrides:

canTeleport in class PlotPlayer<Player>

hasPermissionRange

public @org.checkerframework.checker.index.qual.NonNegative int hasPermissionRange(@NonNull String stub,
 @org.checkerframework.checker.index.qual.NonNegative int range)

teleport

public void teleport(@NonNull Location location,
 @NonNull TeleportCause cause)

Specified by:

teleport in class PlotPlayer<Player>

getName

public String getName()

setCompassTarget

public void setCompassTarget(Location location)

Specified by:

setCompassTarget in class PlotPlayer<Player>

getLocationFull

public Location getLocationFull()

Specified by:

getLocationFull in class PlotPlayer<Player>

setWeather

public void setWeather(@NonNull PlotWeather weather)

Specified by:

setWeather in class PlotPlayer<Player>

getGameMode

public com.sk89q.worldedit.world.gamemode.GameMode getGameMode()

Specified by:

getGameMode in class PlotPlayer<Player>

setGameMode

public void setGameMode(com.sk89q.worldedit.world.gamemode.GameMode gameMode)

Specified by:

setGameMode in class PlotPlayer<Player>

setTime

public void setTime(long time)

Specified by:

setTime in class PlotPlayer<Player>

getFlight

public boolean getFlight()

Specified by:

getFlight in class PlotPlayer<Player>

setFlight

public void setFlight(boolean fly)

Specified by:

setFlight in class PlotPlayer<Player>

playMusic

public void playMusic(@NonNull Location location,
 @NonNull com.sk89q.worldedit.world.item.ItemType id)

Specified by:

playMusic in class PlotPlayer<Player>

kick

public void kick(String message)

Specified by:

kick in class PlotPlayer<Player>

stopSpectating

public void stopSpectating()

Specified by:

stopSpectating in class PlotPlayer<Player>

isBanned

public boolean isBanned()

Specified by:

isBanned in class PlotPlayer<Player>

getAudience

public @NonNull Audience getAudience()

Specified by:

getAudience in class PlotPlayer<Player>

removeEffect

public void removeEffect(@NonNull String name)

Specified by:

removeEffect in class PlotPlayer<Player>

canSee

public boolean canSee(PlotPlayer<?> other)

Specified by:

canSee in class PlotPlayer<Player>

getTeleportCause

public PlayerTeleportEvent.TeleportCause getTeleportCause(@NonNull TeleportCause cause)

Convert from PlotSquared's TeleportCause to Bukkit's PlayerTeleportEvent.TeleportCause

Parameters:

cause - PlotSquared teleport cause to convert

Returns:

Bukkit's equivalent teleport cause