eu.wauz.wauzcore.system.achievements

Class WauzAchievement

java.lang.Object

eu.wauz.wauzcore.system.achievements.WauzAchievement

public class WauzAchievement
extends java.lang.Object

An achievement, generated from the achievement config file.

Author:

Wauzmons

See Also:

AchievementTracker

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<WauzAchievementType,java.util.Map<java.lang.String,WauzAchievement>>	achievementGoalMap A map with mappings of non generic achievement goals to their achievements, indexed by type.
private static java.util.Map<WauzAchievementType,java.util.List<WauzAchievement>>	achievementMap A map with lists of achievements, indexed by type.
private int	goal The required value to complete the achievement.
private java.lang.String	goalString The required target name to complete the achievement.
private java.lang.String	key The key of the achievement.
private java.lang.String	name The name of the achievement.
private int	reward The amount of soulstones to receive as an achievement reward.
private WauzAchievementType	type The type of the achievement.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WauzAchievement(java.lang.String key) Constructor for a new achievement.

Method Summary

Modifier and Type	Method and Description
void	award(org.bukkit.entity.Player player) Grants this achievement to the player and increases ther achievement count.
static int	getAchievementCount() Gets the number of all earnable achievements.
static WauzAchievement	getAchievementForGoal(WauzAchievementType type, java.lang.String goal) Gets a non generic achievement for the given goal, if existant.
static java.util.List<WauzAchievement>	getAchievementsOfType(WauzAchievementType type) Gets all achievements of the given type.
static WauzAchievement	getCurrentAchievementStage(org.bukkit.entity.Player player, WauzAchievementType type) Gets the highest achievement of this type, that the given player earned.
int	getGoal()
java.lang.String	getGoalString()
java.lang.String	getKey()
java.lang.String	getName()
static WauzAchievement	getNextAchievementStage(org.bukkit.entity.Player player, WauzAchievementType type) Gets the next achievement of this type, that the player has not earned yet.
int	getReward()
WauzAchievementType	getType()
static void	init() Initializes all achievements and fills the internal achievement maps.
void	setGoal(int goal)
void	setGoalString(java.lang.String goalString)
void	setKey(java.lang.String key)
void	setName(java.lang.String name)
void	setReward(int reward)
void	setType(WauzAchievementType type)

Methods inherited from class java.lang.Object

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

Field Detail

achievementMap

private static java.util.Map<WauzAchievementType,java.util.List<WauzAchievement>> achievementMap

A map with lists of achievements, indexed by type.

achievementGoalMap

private static java.util.Map<WauzAchievementType,java.util.Map<java.lang.String,WauzAchievement>> achievementGoalMap

A map with mappings of non generic achievement goals to their achievements, indexed by type.

key

private java.lang.String key

The key of the achievement.

name

private java.lang.String name

The name of the achievement.

type

private WauzAchievementType type

The type of the achievement.

goalString

private java.lang.String goalString

The required target name to complete the achievement.

goal

private int goal

The required value to complete the achievement.

reward

private int reward

The amount of soulstones to receive as an achievement reward.

Constructor Detail

WauzAchievement

private WauzAchievement(java.lang.String key)

Constructor for a new achievement.

Parameters:

key - The key of the achievement.

Method Detail

getAchievementCount

public static int getAchievementCount()

Gets the number of all earnable achievements.

Returns:

The achievement count.

init

public static void init()

Initializes all achievements and fills the internal achievement maps.

See Also:

AchievementConfigurator.getAchievementKeys()

getAchievementForGoal

public static WauzAchievement getAchievementForGoal(WauzAchievementType type,
                                                    java.lang.String goal)

Gets a non generic achievement for the given goal, if existant.

Parameters:

type - The non generic achievement type.

goal - The goal to check for.

Returns:

The found achievement or null.

getAchievementsOfType

public static java.util.List<WauzAchievement> getAchievementsOfType(WauzAchievementType type)

Gets all achievements of the given type.

Parameters:

type - The achievement type.

Returns:

The list of achievements.

getCurrentAchievementStage

public static WauzAchievement getCurrentAchievementStage(org.bukkit.entity.Player player,
                                                         WauzAchievementType type)

Gets the highest achievement of this type, that the given player earned.

Parameters:

player - The player that earned the achievement.

type - The type of the achievement.

Returns:

The highest earned achievement.

getNextAchievementStage

public static WauzAchievement getNextAchievementStage(org.bukkit.entity.Player player,
                                                      WauzAchievementType type)

Gets the next achievement of this type, that the player has not earned yet.

Parameters:

player - The player that has to earn the achievement.

type - The type of the achievement.

Returns:

The next achievement to earn.

award

public void award(org.bukkit.entity.Player player)

Grants this achievement to the player and increases ther achievement count.

Parameters:

player - The player that should earn the achievement.

getKey

public java.lang.String getKey()

Returns:

The key of the achievement.

setKey

public void setKey(java.lang.String key)

Parameters:

key - The new key of the achievement.

getName

public java.lang.String getName()

Returns:

The name of the achievement.

setName

public void setName(java.lang.String name)

Parameters:

name - The new name of the achievement.

getType

public WauzAchievementType getType()

Returns:

The type of the achievement.

setType

public void setType(WauzAchievementType type)

Parameters:

type - The new type of the achievement.

getGoalString

public java.lang.String getGoalString()

Returns:

The required target name to complete the achievement.

setGoalString

public void setGoalString(java.lang.String goalString)

Parameters:

goalString - The new required target name to complete the achievement.

getGoal

public int getGoal()

Returns:

The required value to complete the achievement.

setGoal

public void setGoal(int goal)

Parameters:

goal - The new required value to complete the achievement.

getReward

public int getReward()

Returns:

The amount of soulstones to receive as an achievement reward.

setReward

public void setReward(int reward)

Parameters:

reward - The new amount of soulstones to receive as an achievement reward.