Class LevelsFile

java.lang.Object

me.tayebyassine.homestead.resources.ResourceFile

me.tayebyassine.homestead.resources.files.LevelsFile

public final class LevelsFile
extends ResourceFile

Typed accessor for levels.yml.

Constructor Summary

Constructors

Constructor	Description
LevelsFile(File file)

Method Summary

Modifier and Type	Method	Description
int	getKillXpMax(String entityType)	The maximum XP awarded for killing a specific entity type.
int	getKillXpMin(String entityType)	The minimum XP awarded for killing a specific entity type.
int	getRewardChunks(int level)	The chunk-reward bonus for reaching a specific level.
int	getRewardMembers(int level)	The member-reward bonus for reaching a specific level.
int	getRewardSubAreas(int level)	The sub-area-reward bonus for reaching a specific level.
int	getRewardUpkeepReduction(int level)	The upkeep-reduction percentage for reaching a specific level.
int	getTimeout()	The timeout (in minutes) between level-up reward notifications.
boolean	isEnabled()	Whether the region leveling system is enabled.

Methods inherited from class ResourceFile

getBoolean, getBoolean, getConfig, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getIntegerList, getKeysUnderPath, getLong, getLong, getRaw, getString, getString, getStringList

Methods inherited from class Object

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

Constructor Details

LevelsFile

public LevelsFile(File file)
           throws FileNotFoundException

Throws:

FileNotFoundException

Method Details

isEnabled

public boolean isEnabled()

Whether the region leveling system is enabled.

Returns:

true if leveling is active, defaults to false

getTimeout

public int getTimeout()

The timeout (in minutes) between level-up reward notifications.

Returns:

timeout in minutes, defaults to 0 (no cooldown)

getKillXpMin

public int getKillXpMin(String entityType)

The minimum XP awarded for killing a specific entity type.

Parameters:

entityType - the Bukkit entity type name

Returns:

minimum XP, defaults to 0

getKillXpMax

public int getKillXpMax(String entityType)

The maximum XP awarded for killing a specific entity type.

Parameters:

entityType - the Bukkit entity type name

Returns:

maximum XP, defaults to the min value if only one entry exists

getRewardChunks

public int getRewardChunks(int level)

The chunk-reward bonus for reaching a specific level.

Parameters:

level - the region level

Returns:

bonus chunks, defaults to 0

getRewardMembers

public int getRewardMembers(int level)

The member-reward bonus for reaching a specific level.

Parameters:

level - the region level

Returns:

bonus members, defaults to 0

getRewardSubAreas

public int getRewardSubAreas(int level)

The sub-area-reward bonus for reaching a specific level.

Parameters:

level - the region level

Returns:

bonus sub-areas, defaults to 0

getRewardUpkeepReduction

public int getRewardUpkeepReduction(int level)

The upkeep-reduction percentage for reaching a specific level.

Parameters:

level - the region level

Returns:

upkeep-reduction percentage, defaults to 0