Skip to main content

​
Overview

The PlayersManager interface handles player-related operations including retrieving SuperiorPlayer wrappers and managing player containers. Access it via SuperiorSkyblockAPI.getPlayers().

​
Player Retrieval

​
getSuperiorPlayer(String)
@Nullable SuperiorPlayer
Get a player by their name.Parameters:
  • name - The name to check
Returns: The player with that name, or null if not found
​
getSuperiorPlayer(Player)
SuperiorPlayer
Get a player wrapper from a Bukkit Player instance.Parameters:
  • player - The Bukkit player to check
Returns: The SuperiorPlayer wrapper for that player
​
getSuperiorPlayer(UUID)
SuperiorPlayer
Get a player by their UUID.Parameters:
  • uuid - The UUID to check
Returns: The player with that UUID
​
getAllPlayers()
List<SuperiorPlayer>
Get all the players that joined the server.Returns: List of all SuperiorPlayer objects

​
Player Role Methods (Deprecated)

These methods are deprecated. Use the RolesManager instead.
​
getPlayerRole(int)
@Nullable PlayerRole
deprecated
Get a player role by its weight.Parameters:
  • weight - The weight to check
Returns: The player role with that weightDeprecated: Use RolesManager instead
​
getPlayerRoleFromId(int)
@Nullable PlayerRole
deprecated
Get a player role by its id.Parameters:
  • id - The id to check
Returns: The player role with that idDeprecated: Use RolesManager instead
​
getPlayerRole(String)
PlayerRole
deprecated
Get a player role by its name.Parameters:
  • name - The name to check
Returns: The player role with that nameThrows: IllegalArgumentException if there’s no role with that nameDeprecated: Use RolesManager instead
​
getDefaultRole()
PlayerRole
deprecated
Get the default role that players are assigned with when they join an island.Returns: The default player roleDeprecated: Use RolesManager instead
​
getLastRole()
PlayerRole
deprecated
Get the highest role in the ladder - aka, leader’s role.Returns: The leader roleDeprecated: Use RolesManager instead
​
getGuestRole()
PlayerRole
deprecated
Get the guest’s role.Returns: The guest roleDeprecated: Use RolesManager instead
​
getCoopRole()
PlayerRole
deprecated
Get the co-op’s role.Returns: The co-op roleDeprecated: Use RolesManager instead
​
getRoles()
List<PlayerRole>
deprecated
Get a list of all the roles.Returns: List of all player rolesDeprecated: Use RolesManager instead

​
Players Container

​
getPlayersContainer()
PlayersContainer
Get the players container.Returns: The current players container
​
setPlayersContainer(PlayersContainer)
void
Set a new players container.Parameters:
  • playersContainer - The new players container to set

​
Example Usage

import com.bgsoftware.superiorskyblock.api.SuperiorSkyblockAPI;
import com.bgsoftware.superiorskyblock.api.handlers.PlayersManager;
import com.bgsoftware.superiorskyblock.api.wrappers.SuperiorPlayer;
import org.bukkit.entity.Player;

import java.util.List;
import java.util.UUID;

public class PlayersExample {
    public void example(Player bukkitPlayer) {
        PlayersManager playersManager = SuperiorSkyblockAPI.getPlayers();
        
        // Get SuperiorPlayer from Bukkit Player
        SuperiorPlayer superiorPlayer = playersManager.getSuperiorPlayer(bukkitPlayer);
        
        // Get player by name
        SuperiorPlayer player = playersManager.getSuperiorPlayer("PlayerName");
        
        // Get player by UUID
        UUID playerUUID = bukkitPlayer.getUniqueId();
        SuperiorPlayer playerByUUID = playersManager.getSuperiorPlayer(playerUUID);
        
        // Get all players
        List<SuperiorPlayer> allPlayers = playersManager.getAllPlayers();
        System.out.println("Total players: " + allPlayers.size());
        
        // Check if player has an island
        if (superiorPlayer.hasIsland()) {
            System.out.println("Player has an island!");
        }
    }
}
  • SuperiorPlayer: The wrapper class for players that provides island-related methods
  • RolesManager: For managing player roles (replaces deprecated role methods)
  • PlayersContainer: Custom container implementation for storing players