eu.wauz.wauzcore.system

Class WauzRank

java.lang.Object

eu.wauz.wauzcore.system.WauzRank

public class WauzRank
extends java.lang.Object

A player rank, generated from a rank config file.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private int	dailyCoins The daily coin reward of the rank.
private int	dailySoulstones The daily soulstone reward of the rank.
private boolean	grantOp If the rank grants operator permissions.
private boolean	isStaff If the rank is a staff only rank.
private org.bukkit.ChatColor	rankColor The player name color of the rank.
private static java.util.Map<java.lang.String,WauzRank>	rankMap A map of ranks, indexed by name.
private java.lang.String	rankName The name of the rank.
private WauzPermission	rankPermission The player permission of the rank.
private int	rankPermissionLevel The permission level of the rank, used for staff hierarchies.
private java.lang.String	rankPrefix The player name prefix of the rank.
private double	shopDiscount The global shop discount of the rank.

Constructor Summary

Constructors

Constructor and Description
WauzRank(java.lang.String rankName) Constructs a rank, based on the rank file in the /WauzCore folder.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	getAllRankIds()
int	getDailyCoins()
int	getDailySoulstones()
static WauzRank	getRank(org.bukkit.OfflinePlayer player)
static WauzRank	getRank(java.lang.String rankName)
org.bukkit.ChatColor	getRankColor()
java.lang.String	getRankName()
WauzPermission	getRankPermission()
int	getRankPermissionLevel()
java.lang.String	getRankPrefix()
double	getShopDiscount()
static void	init() Initializes all ranks from the config and fills the internal rank map.
boolean	isGrantOp()
boolean	isStaff()
static boolean	isValidRank(java.lang.String rankName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rankMap

private static java.util.Map<java.lang.String,WauzRank> rankMap

A map of ranks, indexed by name.

rankName

private java.lang.String rankName

The name of the rank.

rankPrefix

private java.lang.String rankPrefix

The player name prefix of the rank.

rankColor

private org.bukkit.ChatColor rankColor

The player name color of the rank.

rankPermission

private WauzPermission rankPermission

The player permission of the rank.

rankPermissionLevel

private int rankPermissionLevel

The permission level of the rank, used for staff hierarchies.

grantOp

private boolean grantOp

If the rank grants operator permissions.

isStaff

private boolean isStaff

If the rank is a staff only rank.

dailyCoins

private int dailyCoins

The daily coin reward of the rank.

dailySoulstones

private int dailySoulstones

The daily soulstone reward of the rank.

shopDiscount

private double shopDiscount

The global shop discount of the rank.

Constructor Detail

WauzRank

public WauzRank(java.lang.String rankName)

Constructs a rank, based on the rank file in the /WauzCore folder.

Parameters:

rankName - The name of the rank.

Method Detail

init

public static void init()

Initializes all ranks from the config and fills the internal rank map.

See Also:

RankConfigurator.getAllRankKeys()

isValidRank

public static boolean isValidRank(java.lang.String rankName)

Parameters:

rankName - A rank name.

Returns:

If the rank name is valid.

getRank

public static WauzRank getRank(java.lang.String rankName)

Parameters:

rankName - A rank name.

Returns:

The rank with that name.

getRank

public static WauzRank getRank(org.bukkit.OfflinePlayer player)

Parameters:

player - The player to get the rank of.

Returns:

The rank of the player.

getAllRankIds

public static java.util.List<java.lang.String> getAllRankIds()

Returns:

A list of all rank ids.

getRankName

public java.lang.String getRankName()

Returns:

The name of the rank.

getRankPrefix

public java.lang.String getRankPrefix()

Returns:

The player name prefix of the rank.

getRankColor

public org.bukkit.ChatColor getRankColor()

Returns:

The player name color of the rank.

getRankPermission

public WauzPermission getRankPermission()

Returns:

The player permission of the rank.

getRankPermissionLevel

public int getRankPermissionLevel()

Returns:

The permission level of the rank, used for staff hierarchies.

isGrantOp

public boolean isGrantOp()

Returns:

If the rank grants operator permissions.

isStaff

public boolean isStaff()

Returns:

If the rank is a staff only rank.

getDailyCoins

public int getDailyCoins()

Returns:

The daily coin reward of the rank.

getDailySoulstones

public int getDailySoulstones()

Returns:

The daily soulstone reward of the rank.

getShopDiscount

public double getShopDiscount()

Returns:

The global shop discount of the rank.