Interface ILockSecurityPlayer
public interface ILockSecurityPlayer
Represents a wrapped Bukkit
OfflinePlayer
for LockSecurity's player state.- Since:
- 3.0.0
- Author:
- Parker Hawke - Choco
-
Method Summary
Modifier and Type Method Description Optional<org.bukkit.entity.Player>
getBukkitPlayer()
Get thePlayer
instance wrapped by this player.org.bukkit.OfflinePlayer
getBukkitPlayerOffline()
Get theOfflinePlayer
instance wrapped by this player.UUID
getUniqueId()
Get the UUID of this wrapped player.boolean
hasLockNotifications()
Get whether or not this player should receive lock notifications.boolean
is(org.bukkit.OfflinePlayer player)
Check if thisILockSecurityPlayer
represents the supplied playerboolean
isIgnoringLocks()
Get whether or not this player is ignoring locks.void
setIgnoringLocks(boolean ignoringLocks)
Set whether or not this player is ignoring locks.void
setLockNotifications(boolean notifications)
Set whether or not this player should receive lock notifications.
-
Method Details
-
getBukkitPlayer
Get thePlayer
instance wrapped by this player. If the player is not online, the returned optional will be empty.- Returns:
- the wrapped
Player
-
getBukkitPlayerOffline
@NotNull org.bukkit.OfflinePlayer getBukkitPlayerOffline()Get theOfflinePlayer
instance wrapped by this player.- Returns:
- the wrapped
OfflinePlayer
-
getUniqueId
Get the UUID of this wrapped player.- Returns:
- the wrapped player UUID
-
is
boolean is(@Nullable org.bukkit.OfflinePlayer player)Check if thisILockSecurityPlayer
represents the supplied player- Parameters:
player
- the player to check- Returns:
- true if the players are the same
-
setIgnoringLocks
void setIgnoringLocks(boolean ignoringLocks)Set whether or not this player is ignoring locks.- Parameters:
ignoringLocks
- whether or not to ignore locks
-
isIgnoringLocks
boolean isIgnoringLocks()Get whether or not this player is ignoring locks.- Returns:
- true if ignoring locks, false otherwise
-
setLockNotifications
void setLockNotifications(boolean notifications)Set whether or not this player should receive lock notifications.- Parameters:
notifications
- whether or not to send lock notifications
-
hasLockNotifications
boolean hasLockNotifications()Get whether or not this player should receive lock notifications.- Returns:
- true if receiving lock notifications, false otherwise
-