com.bgsoftware.superiorskyblock.api.island

Interface PlayerRole

public interface PlayerRole

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Get the display-name of the role.
int	getId() Get the id of the role.
java.lang.String	getName() Get the name of the role.
PlayerRole	getNextRole() Get the next role in the ladder.
PlayerRole	getPreviousRole() Get the previous role in the ladder.
int	getWeight() Get the weight of the role in the ladder.
boolean	isFirstRole() Check whether or not the role is the first role in the ladder.
boolean	isHigherThan(PlayerRole role) Check whether or not the role is higher than another role.
boolean	isLastRole() Check whether or not the role is the last role in the ladder.
boolean	isLessThan(PlayerRole role) Check whether or not the role is less than another role.
boolean	isRoleLadder() Check whether or not the role is the role is in the ladder.

Method Detail

getId

int getId()

Get the id of the role.

getName

java.lang.String getName()

Get the name of the role.

getDisplayName

java.lang.String getDisplayName()

Get the display-name of the role. This is shown in chat, placeholders, etc.

getWeight

int getWeight()

Get the weight of the role in the ladder.

isHigherThan

boolean isHigherThan(PlayerRole role)

Check whether or not the role is higher than another role.

Parameters:

role - The role to check.

isLessThan

boolean isLessThan(PlayerRole role)

Check whether or not the role is less than another role.

Parameters:

role - The role to check.

isFirstRole

boolean isFirstRole()

Check whether or not the role is the first role in the ladder.

isLastRole

boolean isLastRole()

Check whether or not the role is the last role in the ladder.

isRoleLadder

boolean isRoleLadder()

Check whether or not the role is the role is in the ladder.

getNextRole

@Nullable
PlayerRole getNextRole()

Get the next role in the ladder. Will return null if the role is not in the ladder, or it's the last role in the ladder.

getPreviousRole

@Nullable
PlayerRole getPreviousRole()

Get the previous role in the ladder. Will return null if the role is not in the ladder, or it's the first role in the ladder.