Package us.talabrek.ultimateskyblock.api
Interface IslandInfo
public interface IslandInfo
Public API for an island.
- Since:
- 2.6.2
-
Method Summary
Modifier and TypeMethodDescriptionboolean
banPlayer
(@NotNull org.bukkit.OfflinePlayer target) Bans a player from this island.boolean
banPlayer
(@NotNull org.bukkit.OfflinePlayer target, @Nullable org.bukkit.OfflinePlayer initializer) Bans a player from this island.boolean
contains
(org.bukkit.Location loc) Checks whether a location is within the island borders.getBans()
List of players banned from this island.getBiome()
The name of the biome.Returns the maximum number of blocks of limited types that can be placed on the island.org.bukkit.Location
The location of the island.Returns the player-name of the island-leader.double
getLevel()
The currently registered level of this island.getLog()
The latest event-log for the island.int
Returns the maximum number of animals that can spawn on this island.int
Returns the maximum number of golems (snowmen and iron-golems) that can spawn on this island.int
Returns the maximum number of monsters (including squids) that can spawn on this island.int
Returns the maximum number of members this island can have.int
Returns the maximum number of villagers that can spawn on this island.The player-names of all the island-members (including the leader).getName()
List<org.bukkit.entity.Player>
List of members currently online.int
The current party-size of the island.Returns the current schematic-name for the island).double
Returns a score-multiplier for this islanddouble
Returns a score-offset for this islandDeprecated.Use #getTrusteeUUIDs insteadorg.bukkit.Location
The (possiblynull
) location of the island-warp.boolean
True if at least one member of the island is online.boolean
isBanned
(@NotNull org.bukkit.OfflinePlayer target) Checks if the given player is banned on this island.boolean
isBanned
(org.bukkit.entity.Player player) Deprecated.boolean
isLeader
(org.bukkit.entity.Player player) True if the player is the leader of this island.boolean
isParty()
True if this island constitutes a party (more than 1 member).boolean
isTrusted
(@NotNull org.bukkit.OfflinePlayer target) Checks if the given player is trusted on this island.boolean
trustPlayer
(@NotNull org.bukkit.OfflinePlayer target) Trusts a player on this island.boolean
trustPlayer
(@NotNull org.bukkit.OfflinePlayer target, @Nullable org.bukkit.OfflinePlayer initializer) Trusts a player on this island.boolean
unbanPlayer
(@NotNull org.bukkit.OfflinePlayer target) Unbans a player from this island.boolean
unbanPlayer
(@NotNull org.bukkit.OfflinePlayer target, @Nullable org.bukkit.OfflinePlayer initializer) Unbans a player from this island.boolean
untrustPlayer
(@NotNull org.bukkit.OfflinePlayer target) Untrusts a player on this island.boolean
untrustPlayer
(@NotNull org.bukkit.OfflinePlayer target, @Nullable org.bukkit.OfflinePlayer initializer) Untrusts a player on this island.
-
Method Details
-
getMaxPartySize
int getMaxPartySize()Returns the maximum number of members this island can have.- Returns:
- the maximum number of members this island can have.
-
getMaxAnimals
int getMaxAnimals()Returns the maximum number of animals that can spawn on this island. Note: Only enforced ifspawn-limits
are enabled inconfig.yml
- Returns:
- the maximum number of animals that can spawn on this island.
-
getMaxMonsters
int getMaxMonsters()Returns the maximum number of monsters (including squids) that can spawn on this island. Note: Only enforced ifspawn-limits
are enabled inconfig.yml
- Returns:
- the maximum number of monsters that can spawn on this island.
-
getMaxVillagers
int getMaxVillagers()Returns the maximum number of villagers that can spawn on this island. Note: Only enforced ifspawn-limits
are enabled inconfig.yml
- Returns:
- the maximum number of villagers that can spawn on this island.
-
getMaxGolems
int getMaxGolems()Returns the maximum number of golems (snowmen and iron-golems) that can spawn on this island. Note: Only enforced ifspawn-limits
are enabled inconfig.yml
- Returns:
- the maximum number of golems that can spawn on this island.
-
getBlockLimits
Returns the maximum number of blocks of limited types that can be placed on the island.- Since:
- v2.7.6
-
getLeader
String getLeader()Returns the player-name of the island-leader.- Returns:
- the player-name of the island-leader.
-
getMembers
The player-names of all the island-members (including the leader).- Returns:
- The player-names of all the island-members (including the leader).
-
getBiome
String getBiome()The name of the biome.- Returns:
- The name of the biome.
-
getPartySize
int getPartySize()The current party-size of the island.- Returns:
- The current party-size of the island.
-
isLeader
boolean isLeader(org.bukkit.entity.Player player) True if the player is the leader of this island.- Parameters:
player
- The player to query for- Returns:
- True if the player is the leader of this island.
-
getName
String getName() -
isBanned
boolean isBanned(org.bukkit.entity.Player player) Deprecated.True if the player has been banned from this island.- Parameters:
player
- The player to query for- Returns:
- True if the player has been banned from this island.
-
getBans
List of players banned from this island.- Returns:
- List of players banned from this island.
-
banPlayer
boolean banPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target) Bans a player from this island. Plugins using this function should check if the initializer is authorized to ban a player.- Parameters:
target
- TheOfflinePlayer
to ban.- Returns:
- True if the player was banned, false otherwise. Returns false if the player is banned already.
- Since:
- 2.7.8
-
banPlayer
boolean banPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target, @Nullable @Nullable org.bukkit.OfflinePlayer initializer) Bans a player from this island. Plugins using this function should check if the initializer is authorized to ban a player.- Parameters:
target
- TheOfflinePlayer
to ban.initializer
- TheOfflinePlayer
initializing this request.- Returns:
- True if the player was banned, false otherwise. Returns false if the player is banned already.
- Since:
- 2.7.8
-
unbanPlayer
boolean unbanPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target) Unbans a player from this island. Plugins using this function should check if the initializer is authorized to unban a player.- Parameters:
target
- TheOfflinePlayer
to unban.- Returns:
- True if the player was unbanned, false otherwise. Returns false if the player is unbanned already.
- Since:
- 2.7.8
-
unbanPlayer
boolean unbanPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target, @Nullable @Nullable org.bukkit.OfflinePlayer initializer) Unbans a player from this island. Plugins using this function should check if the initializer is authorized to unban a player.- Parameters:
target
- TheOfflinePlayer
to unban.initializer
- theOfflinePlayer
initializing this request.- Returns:
- True if the player was unbanned, false otherwise. Returns false if the player is unbanned already.
- Since:
- 2.7.8
-
isBanned
boolean isBanned(@NotNull @NotNull org.bukkit.OfflinePlayer target) Checks if the given player is banned on this island.- Parameters:
target
- TheOfflinePlayer
to query for.- Returns:
- True if the player is banned on this island, false otherwise.
- Since:
- 2.7.8
-
getTrustees
Deprecated.Use #getTrusteeUUIDs insteadList of players trusted on this island.- Returns:
- List of players trusted on this island.
-
trustPlayer
boolean trustPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target) Trusts a player on this island. Plugins using this function should check if the initializer is authorized to trust a player.- Parameters:
target
- TheOfflinePlayer
to trust.- Returns:
- True if the player was trusted, false otherwise.
- Since:
- 2.7.7
-
trustPlayer
boolean trustPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target, @Nullable @Nullable org.bukkit.OfflinePlayer initializer) Trusts a player on this island. Plugins using this function should check if the initializer is authorized to trust a player.- Parameters:
target
- TheOfflinePlayer
to trust.initializer
- TheOfflinePlayer
initializing this request.- Returns:
- True if the player was trusted, false otherwise.
- Since:
- 2.7.7
-
untrustPlayer
boolean untrustPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target) Untrusts a player on this island. Plugins using this function should check if the initializer is authorized to untrust a player.- Parameters:
target
- TheOfflinePlayer
to untrust.- Returns:
- True if the player was untrusted, false otherwise.
- Since:
- 2.7.7
-
untrustPlayer
boolean untrustPlayer(@NotNull @NotNull org.bukkit.OfflinePlayer target, @Nullable @Nullable org.bukkit.OfflinePlayer initializer) Untrusts a player on this island. Plugins using this function should check if the initializer is authorized to untrust a player.- Parameters:
target
- TheOfflinePlayer
to untrust.initializer
- TheOfflinePlayer
initializing this request.- Returns:
- True if the player was untrusted, false otherwise.
- Since:
- 2.7.7
-
isTrusted
boolean isTrusted(@NotNull @NotNull org.bukkit.OfflinePlayer target) Checks if the given player is trusted on this island.- Parameters:
target
- TheOfflinePlayer
to query for.- Returns:
- True if the player is trusted on this island, false otherwise.
- Since:
- 2.7.7
-
getLevel
double getLevel()The currently registered level of this island.- Returns:
- The currently registered level of this island.
-
getLog
The latest event-log for the island. Note: Sorted in inverse chronological order- Returns:
- The latest event-log for the island.
-
isParty
boolean isParty()True if this island constitutes a party (more than 1 member).- Returns:
- True if this island constitutes a party (more than 1 member).
-
getWarpLocation
org.bukkit.Location getWarpLocation()The (possiblynull
) location of the island-warp.- Returns:
- The (possibly
null
) location of the island-warp.
-
getIslandLocation
org.bukkit.Location getIslandLocation()The location of the island. Should never be null, but if data is corrupt, it might be.- Returns:
- The location of the island.
-
hasOnlineMembers
boolean hasOnlineMembers()True if at least one member of the island is online.- Returns:
- True if at least one member of the island is online.
-
getOnlineMembers
List<org.bukkit.entity.Player> getOnlineMembers()List of members currently online.- Returns:
- List of members currently online.
-
contains
boolean contains(org.bukkit.Location loc) Checks whether a location is within the island borders.- Parameters:
loc
- The location to test for.- Returns:
- Checks whether a location is within the island borders.
-
getSchematicName
String getSchematicName()Returns the current schematic-name for the island).- Returns:
- Returns the current schematic-name for the island).
-
getScoreMultiplier
double getScoreMultiplier()Returns a score-multiplier for this island- Returns:
- a score-multiplier for this island (default 1).
- Since:
- v2.6.13
-
getScoreOffset
double getScoreOffset()Returns a score-offset for this island- Returns:
- a score-offset for this island (default 1).
- Since:
- v2.6.13
-