eu.wauz.wauzcore.system.quests

Class QuestProcessor

java.lang.Object

eu.wauz.wauzcore.system.quests.QuestProcessor

public class QuestProcessor
extends java.lang.Object

A class to manage quest progression of players.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private org.bukkit.entity.Player	player The player who is doing the quest.
private WauzQuest	quest The quest of the player;
private java.lang.String	questName The name of the quest.
private int	questPhase The current phase of the quest.
private int	questPhaseAmount The total amount of quest phases.
private java.lang.String	questSlot The slot of the quest.
private java.lang.String	questType The type of the quest;

Constructor Summary

Constructors

Modifier	Constructor and Description
private	QuestProcessor(org.bukkit.entity.Player player, java.lang.String questName) Create a quest processor to manage the progression of a player's quest.

Method Summary

Modifier and Type	Method and Description
private void	acceptQuest() Lets the player accept the quest.
private boolean	checkQuestCompletion() Determines if the quest cannot be repeated right now.
private boolean	checkQuestObjectives() Determines if all objectives of the quest phase are fulfilled.
private boolean	checkQuestSlots() Determines the quest slot to use.
private void	completeQuestStep() Starts the next quest phase or completes the quest.
static void	processQuest(org.bukkit.entity.Player player, java.lang.String questName) Tries to accept or continue the quest.
private void	run() Tries to accept or continue the quest.

Methods inherited from class java.lang.Object

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

Field Detail

player

private final org.bukkit.entity.Player player

The player who is doing the quest.

quest

private final WauzQuest quest

The quest of the player;

questName

private final java.lang.String questName

The name of the quest.

questType

private final java.lang.String questType

The type of the quest;

questPhase

private int questPhase

The current phase of the quest.

questPhaseAmount

private final int questPhaseAmount

The total amount of quest phases.

questSlot

private java.lang.String questSlot

The slot of the quest.

Constructor Detail

QuestProcessor

private QuestProcessor(org.bukkit.entity.Player player,
                       java.lang.String questName)

Create a quest processor to manage the progression of a player's quest.

Parameters:

player - The player who is doing the quest.

questName - The name of the quest.

Method Detail

processQuest

public static void processQuest(org.bukkit.entity.Player player,
                                java.lang.String questName)

Tries to accept or continue the quest.

Parameters:

player - The player who is doing the quest.

questName - The name of the quest.

See Also:

The internal logic.

run

private void run()

Tries to accept or continue the quest.

See Also:

checkQuestSlots(), checkQuestCompletion(), acceptQuest(), checkQuestCompletion(), completeQuestStep()

checkQuestSlots

private boolean checkQuestSlots()

Determines the quest slot to use. If the quest isn't already running and no quest slot of the fitting type is available, false will be retuned, so the interaction can be cancelled.

Returns:

If a usable quest slot was found.

See Also:

PlayerConfigurator.getCharacterRunningMainQuest(Player)

checkQuestCompletion

private boolean checkQuestCompletion()

Determines if the quest cannot be repeated right now. If the quest is daily and has a cooldown, the remaining time, till the quest is redoable is shown. If the quest is not daily and already complete, a completion message is shown.

Returns:

If the quest cannot be repeated right now.

See Also:

PlayerQuestConfigurator.getQuestCooldown(Player, String), PlayerQuestConfigurator.isQuestCompleted(Player, String), WauzQuest.getCompletedDialog()

checkQuestObjectives

private boolean checkQuestObjectives()

Determines if all objectives of the quest phase are fulfilled. If the quest is running and phase requirements are not met, an "uncomplete" message is shown.

Returns:

If all quest objectives are fulfilled.

See Also:

QuestRequirementChecker.checkRequirements(), WauzQuest.getUncompletedMessage(int)

acceptQuest

private void acceptQuest()

Lets the player accept the quest. If the quest is unstarted, an accept dialog is shown, or accepted directly, if it is a main quest.

See Also:

WauzPlayerEventQuestAccept

completeQuestStep

private void completeQuestStep()

Starts the next quest phase or completes the quest. If the phase is completed, the next phase is initiated and an phase description message is shown. If all phases are completed, the reward chooser dialog is opened.

See Also:

WauzQuest.getPhaseDialog(int), PlayerQuestConfigurator.setQuestPhase(Player, String, int), QuestRewardChooser.open(Player, WauzQuest, WauzPlayerEventQuestComplete)