SuperiorPlayer

All Superinterfaces:: IDatabaseBridgeHolder, IMissionsHolder, IPersistentDataHolder

public interface SuperiorPlayer
extends IMissionsHolder, IPersistentDataHolder, IDatabaseBridgeHolder

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`org.bukkit.OfflinePlayer`	`asOfflinePlayer()` Get the offline-player object.
`org.bukkit.entity.Player`	`asPlayer()` Get the player object.
`HitActionResult`	`canHit(SuperiorPlayer otherPlayer)` Check whether or not this player can hit another player.
`BorderColor`	`getBorderColor()` Get the border color of the player.
`int`	`getDisbands()` Get the amount of left disbands.
`Island`	`getIsland()` Get the island of the player.
`SuperiorPlayer`	`getIslandLeader()` Get the island owner of the player's island.
`long`	`getLastTimeStatus()` Get the last time player joined or left the server.
`org.bukkit.Location`	`getLocation()` Get the location of the player.
`java.lang.String`	`getName()` Get the last known name of the player.
`PlayerRole`	`getPlayerRole()` Get the role of the player.
`BlockPosition`	`getSchematicPos1()` Get the first schematic position of the player.
`BlockPosition`	`getSchematicPos2()` Get the second schematic position of the player.
`org.bukkit.scheduler.BukkitTask`	`getTeleportTask()` Get the current active teleport task of the player.
`java.lang.String`	`getTextureValue()` Get the last known skin-texture value of the player.
`java.util.UUID`	`getUniqueId()` Get the UUID of the player.
`java.util.Locale`	`getUserLocale()` Get the locale of the player.
`org.bukkit.World`	`getWorld()` Get the world that the player is inside.
`boolean`	`hasAdminSpyEnabled()` Check whether or not the player has admin spy mode enabled.
`boolean`	`hasBlocksStackerEnabled()` Check whether or not the blocks stacker mode is enabled for the player.
`boolean`	`hasBypassModeEnabled()` Check whether or not the bypass mode is enabled for the player.
`boolean`	`hasDisbands()` Check whether or not the player has more disbands.
`boolean`	`hasFlyGamemode()` Check whether or not this player is in a gamemode with fly mode enabled.
`boolean`	`hasIsland()` Check if this player is a member of an island.
`boolean`	`hasIslandFlyEnabled()` Set whether or not the player has flying enabled.
`boolean`	`hasPermission(IslandPrivilege permission)` Check whether or not the player has a permission on his island.
`boolean`	`hasPermission(java.lang.String permission)` Check whether or not the player has a permission.
`boolean`	`hasPermissionWithoutOP(java.lang.String permission)` Check whether or not the player has a permission without having op.
`boolean`	`hasSchematicModeEnabled()` Check whether or not the schematic mode is enabled for the player.
`boolean`	`hasTeamChatEnabled()` Check whether or not the team chat is enabled for the player.
`boolean`	`hasToggledPanel()` Check whether or not the player has their panel toggled.
`boolean`	`hasWorldBorderEnabled()` Check whether or not the world border is enabled for the player.
`boolean`	`isAFK()` Check whether or not the player is AFK.
`boolean`	`isImmunedToPortals()` Whether the player is immuned to portals or not.
`boolean`	`isImmunedToPvP()` Whether the player is immuned to PvP or not.
`boolean`	`isInsideIsland()` Check whether or not the player is inside their island.
`boolean`	`isLeavingFlag()` Whether the player has just left an island's area or not.
`boolean`	`isOnline()` Check whether or not the player is online.
`boolean`	`isShownAsOnline()` Checks whether the player is shown as online.
`boolean`	`isVanished()` Check whether or not the player is vanished.
`void`	`merge(SuperiorPlayer otherPlayer)` Merge another player into this object.
`void`	`runIfOnline(java.util.function.Consumer<org.bukkit.entity.Player> toRun)` Execute code only if the player is online.
`void`	`setBorderColor(BorderColor borderColor)` Set the border color for the player.
`void`	`setDisbands(int disbands)` Check whether or not the player has a permission.
`void`	`setImmunedToPortals(boolean immuneToPortals)` Set whether or not the player is immuned to portals.
`void`	`setImmunedToPvP(boolean immunedToPvP)` Set immunity to PvP for this player.
`void`	`setIsland(Island island)` Set the island of the player.
`void`	`setIslandLeader(SuperiorPlayer islandLeader)` Deprecated. see `setIsland(Island)`
`void`	`setLeavingFlag(boolean leavingFlag)` Set whether or not the player has just left an island's area.
`void`	`setPlayerRole(PlayerRole playerRole)` Set the role of the player.
`void`	`setSchematicPos1(org.bukkit.block.Block block)` Set the first schematic position of the player.
`void`	`setSchematicPos2(org.bukkit.block.Block block)` Set the second schematic position of the player.
`void`	`setTeleportTask(org.bukkit.scheduler.BukkitTask teleportTask)` Set a teleportation task for the player.
`void`	`setTextureValue(java.lang.String textureValue)` Set the skin-texture value for the player.
`void`	`setToggledPanel(boolean toggledPanel)` Set whether or not the player has their panel toggled.
`void`	`setUserLocale(java.util.Locale locale)` Set the locale of the player.
`void`	`teleport(Island island)` Teleport the player to an island.
`void`	`teleport(Island island, java.util.function.Consumer<java.lang.Boolean> teleportResult)` Teleport the player to an island.
`void`	`teleport(Island island, org.bukkit.World.Environment environment)` Teleport the player to an island.
`void`	`teleport(Island island, org.bukkit.World.Environment environment, java.util.function.Consumer<java.lang.Boolean> teleportResult)` Teleport the player to an island.
`void`	`teleport(org.bukkit.Location location)` Teleport the player to a location.
`void`	`teleport(org.bukkit.Location location, java.util.function.Consumer<java.lang.Boolean> teleportResult)` Teleport the player to a location.
`void`	`toggleAdminSpy()` Toggle admin spy mode.
`void`	`toggleBlocksStacker()` Toggle the blocks stacker for the player.
`void`	`toggleBypassMode()` Toggle the bypass mode for the player.
`void`	`toggleIslandFly()` Toggle flying mode.
`void`	`toggleSchematicMode()` Toggle the schematic mode for the player.
`void`	`toggleTeamChat()` Toggle the team chat for the player.
`void`	`toggleWorldBorder()` Toggle the world border for the player.
`void`	`updateLastTimeStatus()` Update the last time player joined or left the server.
`void`	`updateName()` Update the cached name with the current player's name.
`void`	`updateWorldBorder(Island island)` Update world border for this player.

Methods inherited from interface com.bgsoftware.superiorskyblock.api.missions.IMissionsHolder
canCompleteMissionAgain, completeMission, getAmountMissionCompleted, getCompletedMissions, getCompletedMissionsWithAmounts, hasCompletedMission, resetMission

Methods inherited from interface com.bgsoftware.superiorskyblock.api.persistence.IPersistentDataHolder
getPersistentDataContainer

Methods inherited from interface com.bgsoftware.superiorskyblock.api.data.IDatabaseBridgeHolder
getDatabaseBridge

- Method Detail
  - getUniqueId
```
java.util.UUID getUniqueId()
```
    Get the UUID of the player.
  - getName
```
java.lang.String getName()
```
    Get the last known name of the player.
  - getTextureValue
```
java.lang.String getTextureValue()
```
    Get the last known skin-texture value of the player.
  - setTextureValue
```
void setTextureValue(java.lang.String textureValue)
```
    Set the skin-texture value for the player.
    
    Parameters:
    
    textureValue - The skin texture.
  - updateLastTimeStatus
```
void updateLastTimeStatus()
```
    Update the last time player joined or left the server.
  - getLastTimeStatus
```
long getLastTimeStatus()
```
    Get the last time player joined or left the server.
  - updateName
```
void updateName()
```
    Update the cached name with the current player's name. When the player is offline, nothing will happen.
  - asPlayer
```
@Nullable
org.bukkit.entity.Player asPlayer()
```
    Get the player object.
  - asOfflinePlayer
```
@Nullable
org.bukkit.OfflinePlayer asOfflinePlayer()
```
    Get the offline-player object. This can return null if the player is invalid, for example - npcs.
  - isOnline
```
boolean isOnline()
```
    Check whether or not the player is online.
  - runIfOnline
```
void runIfOnline(java.util.function.Consumer<org.bukkit.entity.Player> toRun)
```
    Execute code only if the player is online.
  - hasFlyGamemode
```
boolean hasFlyGamemode()
```
    Check whether or not this player is in a gamemode with fly mode enabled. When the player is offline, false will be returned.
  - isAFK
```
boolean isAFK()
```
    Check whether or not the player is AFK. When the player is offline, false will be returned.
  - isVanished
```
boolean isVanished()
```
    Check whether or not the player is vanished. When the player is offline, false will be returned.
  - isShownAsOnline
```
boolean isShownAsOnline()
```
    Checks whether the player is shown as online.
    
    Returns:
    
    false if vanished, in spectator mode or offline.
  - hasPermission
```
boolean hasPermission(java.lang.String permission)
```
    Check whether or not the player has a permission. When the player is offline, false will be returned.
  - hasPermissionWithoutOP
```
boolean hasPermissionWithoutOP(java.lang.String permission)
```
    Check whether or not the player has a permission without having op. When the player is offline, false will be returned.
  - hasPermission
```
boolean hasPermission(IslandPrivilege permission)
```
    Check whether or not the player has a permission on his island. When the player doesn't have an island, false will be returned.
  - canHit
```
HitActionResult canHit(SuperiorPlayer otherPlayer)
```
    Check whether or not this player can hit another player.
    Players cannot hit each other if one of the followings is true: 1) They are inside an island that has pvp disabled. 2) One of them has pvp warm-up. 3) They are both in the same island, and they hit each other outside of a pvp world. 4) One of the players isn't online (duh?) 5) The target player is inside an island as a visitor and can't take damage. 6) The target player is inside an island as a coop and can't take damage.
    
    Parameters:
    
    otherPlayer - The other player to check.
  - getWorld
```
@Nullable
org.bukkit.World getWorld()
```
    Get the world that the player is inside. When the player is offline, null will be returned.
  - getLocation
```
@Nullable
org.bukkit.Location getLocation()
```
    Get the location of the player. When the player is offline, null will be returned.
  - teleport
```
void teleport(org.bukkit.Location location)
```
    Teleport the player to a location.
    
    Parameters:
    
    location - The location to teleport the player to.
  - teleport
```
void teleport(org.bukkit.Location location,
              @Nullable
              java.util.function.Consumer<java.lang.Boolean> teleportResult)
```
    Teleport the player to a location.
    
    Parameters:
    
    location - The location to teleport the player to.
    
    teleportResult - The result of the teleportation process.
  - teleport
```
void teleport(Island island)
```
    Teleport the player to an island.
    
    Parameters:
    
    island - The island to teleport the player to.
  - teleport
```
void teleport(Island island,
              org.bukkit.World.Environment environment)
```
    Teleport the player to an island.
    
    Parameters:
    
    island - The island to teleport the player to.
    
    environment - The environment to teleport the player to.
  - teleport
```
void teleport(Island island,
              @Nullable
              java.util.function.Consumer<java.lang.Boolean> teleportResult)
```
    Teleport the player to an island.
    
    Parameters:
    
    island - The island to teleport the player to.
    
    teleportResult - Consumer that will be ran when task is finished.
  - teleport
```
void teleport(Island island,
              org.bukkit.World.Environment environment,
              @Nullable
              java.util.function.Consumer<java.lang.Boolean> teleportResult)
```
    Teleport the player to an island.
    
    Parameters:
    
    island - The island to teleport the player to.
    
    environment - The environment to teleport the player to.
    
    teleportResult - Consumer that will be ran when task is finished.
  - isInsideIsland
```
boolean isInsideIsland()
```
    Check whether or not the player is inside their island. When the player is offline or he doesn't have an island, false will be returned.
  - getIslandLeader
```
SuperiorPlayer getIslandLeader()
```
    Get the island owner of the player's island.
  - setIslandLeader
```
@Deprecated
void setIslandLeader(SuperiorPlayer islandLeader)
```
    Deprecated. see setIsland(Island)
    
    Set the island owner of the player's island. !Can cause issues if not used properly!
    
    Parameters:
    
    islandLeader - The island owner's player.
  - getIsland
```
@Nullable
Island getIsland()
```
    Get the island of the player.
  - setIsland
```
void setIsland(Island island)
```
    Set the island of the player. !Can cause issues if not used properly!
    
    Parameters:
    
    island - The island to set the player to.
    
    Throws:
    
    java.lang.IllegalArgumentException - if island doesn't contain player as a member.
  - hasIsland
```
boolean hasIsland()
```
    Check if this player is a member of an island.
  - getPlayerRole
```
PlayerRole getPlayerRole()
```
    Get the role of the player.
  - setPlayerRole
```
void setPlayerRole(PlayerRole playerRole)
```
    Set the role of the player.
    
    Parameters:
    
    playerRole - The role to give the player.
  - getDisbands
```
int getDisbands()
```
    Get the amount of left disbands.
  - setDisbands
```
void setDisbands(int disbands)
```
    Check whether or not the player has a permission.
  - hasDisbands
```
boolean hasDisbands()
```
    Check whether or not the player has more disbands.
  - getUserLocale
```
java.util.Locale getUserLocale()
```
    Get the locale of the player.
  - setUserLocale
```
void setUserLocale(java.util.Locale locale)
```
    Set the locale of the player.
    
    Parameters:
    
    locale - The locale to set.
  - hasWorldBorderEnabled
```
boolean hasWorldBorderEnabled()
```
    Check whether or not the world border is enabled for the player.
  - toggleWorldBorder
```
void toggleWorldBorder()
```
    Toggle the world border for the player.
  - updateWorldBorder
```
void updateWorldBorder(@Nullable
                       Island island)
```
    Update world border for this player.
    
    Parameters:
    
    island - The island the player should see the border of.
  - hasBlocksStackerEnabled
```
boolean hasBlocksStackerEnabled()
```
    Check whether or not the blocks stacker mode is enabled for the player.
  - toggleBlocksStacker
```
void toggleBlocksStacker()
```
    Toggle the blocks stacker for the player.
  - hasSchematicModeEnabled
```
boolean hasSchematicModeEnabled()
```
    Check whether or not the schematic mode is enabled for the player.
  - toggleSchematicMode
```
void toggleSchematicMode()
```
    Toggle the schematic mode for the player.
  - hasTeamChatEnabled
```
boolean hasTeamChatEnabled()
```
    Check whether or not the team chat is enabled for the player.
  - toggleTeamChat
```
void toggleTeamChat()
```
    Toggle the team chat for the player.
  - hasBypassModeEnabled
```
boolean hasBypassModeEnabled()
```
    Check whether or not the bypass mode is enabled for the player.
  - toggleBypassMode
```
void toggleBypassMode()
```
    Toggle the bypass mode for the player.
  - hasToggledPanel
```
boolean hasToggledPanel()
```
    Check whether or not the player has their panel toggled.
  - setToggledPanel
```
void setToggledPanel(boolean toggledPanel)
```
    Set whether or not the player has their panel toggled.
  - hasIslandFlyEnabled
```
boolean hasIslandFlyEnabled()
```
    Set whether or not the player has flying enabled.
  - toggleIslandFly
```
void toggleIslandFly()
```
    Toggle flying mode.
  - hasAdminSpyEnabled
```
boolean hasAdminSpyEnabled()
```
    Check whether or not the player has admin spy mode enabled.
  - toggleAdminSpy
```
void toggleAdminSpy()
```
    Toggle admin spy mode.
  - getBorderColor
```
BorderColor getBorderColor()
```
    Get the border color of the player.
  - setBorderColor
```
void setBorderColor(BorderColor borderColor)
```
    Set the border color for the player.
    
    Parameters:
    
    borderColor - The color to set.
  - getSchematicPos1
```
BlockPosition getSchematicPos1()
```
    Get the first schematic position of the player. May be null.
  - setSchematicPos1
```
void setSchematicPos1(@Nullable
                      org.bukkit.block.Block block)
```
    Set the first schematic position of the player.
    
    Parameters:
    
    block - The block to change the position to.
  - getSchematicPos2
```
BlockPosition getSchematicPos2()
```
    Get the second schematic position of the player. May be null.
  - setSchematicPos2
```
void setSchematicPos2(@Nullable
                      org.bukkit.block.Block block)
```
    Set the second schematic position of the player.
    
    Parameters:
    
    block - The block to change the position to.
  - isImmunedToPvP
```
boolean isImmunedToPvP()
```
    Whether the player is immuned to PvP or not.
  - setImmunedToPvP
```
void setImmunedToPvP(boolean immunedToPvP)
```
    Set immunity to PvP for this player.
    
    Parameters:
    
    immunedToPvP - Whether or not the player should be immuned to PvP.
  - isLeavingFlag
```
boolean isLeavingFlag()
```
    Whether the player has just left an island's area or not.
  - setLeavingFlag
```
void setLeavingFlag(boolean leavingFlag)
```
    Set whether or not the player has just left an island's area. If set to true, the player will not be able to escape islands.
    
    Parameters:
    
    leavingFlag - Whether or not the island has left an island's area.
  - getTeleportTask
```
@Nullable
org.bukkit.scheduler.BukkitTask getTeleportTask()
```
    Get the current active teleport task of the player.
  - setTeleportTask
```
void setTeleportTask(@Nullable
                     org.bukkit.scheduler.BukkitTask teleportTask)
```
    Set a teleportation task for the player. This is used for warmpups, etc.
    
    Parameters:
    
    teleportTask - The teleport task to set.
  - isImmunedToPortals
```
boolean isImmunedToPortals()
```
    Whether the player is immuned to portals or not.
  - setImmunedToPortals
```
void setImmunedToPortals(boolean immuneToPortals)
```
    Set whether or not the player is immuned to portals. If set to true, players will not be able to get teleported through portals.
    
    Parameters:
    
    immuneToPortals - Whether the player should be immuned or not.
  - merge
```
void merge(SuperiorPlayer otherPlayer)
```
    Merge another player into this object.

Interface SuperiorPlayer

Method Summary

Methods inherited from interface com.bgsoftware.superiorskyblock.api.missions.IMissionsHolder

Methods inherited from interface com.bgsoftware.superiorskyblock.api.persistence.IPersistentDataHolder

Methods inherited from interface com.bgsoftware.superiorskyblock.api.data.IDatabaseBridgeHolder

Method Detail

getUniqueId

getName

getTextureValue

setTextureValue

updateLastTimeStatus

getLastTimeStatus

updateName

asPlayer

asOfflinePlayer

isOnline

runIfOnline

hasFlyGamemode

isAFK

isVanished

isShownAsOnline

hasPermission

hasPermissionWithoutOP

hasPermission

canHit

getWorld

getLocation

teleport

teleport

teleport

teleport

teleport

teleport

isInsideIsland

getIslandLeader

setIslandLeader

getIsland

setIsland

hasIsland

getPlayerRole

setPlayerRole

getDisbands

setDisbands

hasDisbands

getUserLocale

setUserLocale

hasWorldBorderEnabled

toggleWorldBorder

updateWorldBorder

hasBlocksStackerEnabled

toggleBlocksStacker

hasSchematicModeEnabled

toggleSchematicMode

hasTeamChatEnabled

toggleTeamChat

hasBypassModeEnabled

toggleBypassMode

hasToggledPanel

setToggledPanel

hasIslandFlyEnabled

toggleIslandFly

hasAdminSpyEnabled

toggleAdminSpy

getBorderColor

setBorderColor

getSchematicPos1

setSchematicPos1

getSchematicPos2

setSchematicPos2

isImmunedToPvP

setImmunedToPvP

isLeavingFlag

setLeavingFlag

getTeleportTask

setTeleportTask

isImmunedToPortals

setImmunedToPortals

merge