com.bgsoftware.superiorskyblock.api.handlers

Interface RolesManager

public interface RolesManager

Method Summary

Modifier and Type	Method and Description
PlayerRole	getCoopRole() Get the co-op's role.
PlayerRole	getDefaultRole() Get the default role that players are assigned with when they join an island.
PlayerRole	getGuestRole() Get the guest's role.
PlayerRole	getLastRole() Get the highest role in the ladder - aka, leader's role.
PlayerRole	getPlayerRole(int weight) Get a player role by it's weight.
PlayerRole	getPlayerRole(java.lang.String name) Get a player role by it's name.
PlayerRole	getPlayerRoleFromId(int id) Get a player role by it's id.
java.util.List<PlayerRole>	getRoles() Get a list of all the roles.

Method Detail

getPlayerRole

@Nullable
PlayerRole getPlayerRole(int weight)

Get a player role by it's weight.

Parameters:

weight - The weight to check.

Returns:

The player role with that weight.

getPlayerRoleFromId

@Nullable
PlayerRole getPlayerRoleFromId(int id)

Get a player role by it's id.

Parameters:

id - The id to check.

Returns:

The player role with that weight.

getPlayerRole

PlayerRole getPlayerRole(java.lang.String name)

Get a player role by it's name.

Parameters:

name - The name to check.

Returns:

The player role with that name. If there's no role with that name, IllegalArgumentException will be thrown.

getDefaultRole

PlayerRole getDefaultRole()

Get the default role that players are assigned with when they join an island.

getLastRole

PlayerRole getLastRole()

Get the highest role in the ladder - aka, leader's role.

getGuestRole

PlayerRole getGuestRole()

Get the guest's role.

getCoopRole

PlayerRole getCoopRole()

Get the co-op's role.

getRoles

java.util.List<PlayerRole> getRoles()

Get a list of all the roles.