eu.wauz.wauzcore.data.players

Class PlayerQuestConfigurator

java.lang.Object

eu.wauz.wauzcore.data.api.PlayerQuestConfigurationUtils

eu.wauz.wauzcore.data.players.PlayerQuestConfigurator

public class PlayerQuestConfigurator
extends PlayerQuestConfigurationUtils

Configurator to fetch or modify data from the PlayerQuest.yml files.

Author:

Wauzmons

Constructor Summary

Constructors

Constructor and Description
PlayerQuestConfigurator()

Method Summary

Modifier and Type	Method and Description
static void	addQuestCompletions(org.bukkit.entity.Player player, java.lang.String quest) Increases the quest completions by 1.
static int	getQuestCompletions(org.bukkit.entity.Player player, java.lang.String quest)
static long	getQuestCooldown(org.bukkit.entity.Player player, java.lang.String quest)
static int	getQuestPhase(org.bukkit.entity.Player player, java.lang.String quest)
static long	getQuestPhaseRequirementValue(org.bukkit.entity.Player player, java.lang.String quest, int phase, int requirement)
static boolean	isQuestCompleted(org.bukkit.entity.Player player, java.lang.String quest)
static void	setQuestCooldown(org.bukkit.entity.Player player, java.lang.String quest) Updates the cooldown of the quest to now.
static void	setQuestPhase(org.bukkit.entity.Player player, java.lang.String quest, int phase)
static void	setQuestPhaseRequirementValue(org.bukkit.entity.Player player, java.lang.String quest, int phase, int requirement, long value)

Methods inherited from class eu.wauz.wauzcore.data.api.PlayerQuestConfigurationUtils

playerQuestConfigGetInt, playerQuestConfigGetLong, playerQuestConfigSet

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerQuestConfigurator

public PlayerQuestConfigurator()

Method Detail

getQuestPhase

public static int getQuestPhase(org.bukkit.entity.Player player,
                                java.lang.String quest)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

Returns:

The phase of the quest.

setQuestPhase

public static void setQuestPhase(org.bukkit.entity.Player player,
                                 java.lang.String quest,
                                 int phase)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

phase - The new phase of the quest.

getQuestPhaseRequirementValue

public static long getQuestPhaseRequirementValue(org.bukkit.entity.Player player,
                                                 java.lang.String quest,
                                                 int phase,
                                                 int requirement)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

phase - The phase of the quest.

requirement - The requirement of the phase of the quest.

Returns:

The stored value for the requirement.

setQuestPhaseRequirementValue

public static void setQuestPhaseRequirementValue(org.bukkit.entity.Player player,
                                                 java.lang.String quest,
                                                 int phase,
                                                 int requirement,
                                                 long value)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

phase - The phase of the quest.

requirement - The requirement of the phase of the quest.

value - The new stored value for the requirement.

getQuestCompletions

public static int getQuestCompletions(org.bukkit.entity.Player player,
                                      java.lang.String quest)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

Returns:

The amount the quest was completed.

addQuestCompletions

public static void addQuestCompletions(org.bukkit.entity.Player player,
                                       java.lang.String quest)

Increases the quest completions by 1.

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

isQuestCompleted

public static boolean isQuestCompleted(org.bukkit.entity.Player player,
                                       java.lang.String quest)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

Returns:

If the quest has been completed at least once.

getQuestCooldown

public static long getQuestCooldown(org.bukkit.entity.Player player,
                                    java.lang.String quest)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.

Returns:

The cooldown of the quest. (Last time it was completed)

setQuestCooldown

public static void setQuestCooldown(org.bukkit.entity.Player player,
                                    java.lang.String quest)

Updates the cooldown of the quest to now. (Last time it was completed)

Parameters:

player - The player that owns the config file.

quest - The quest that the config belongs to.