eu.wauz.wauzcore.system.quests

Class QuestRequirementChecker

java.lang.Object

eu.wauz.wauzcore.system.quests.QuestRequirementChecker

Direct Known Subclasses:

QuestRequirementCheckerItems, QuestRequirementCheckerKills

public abstract class QuestRequirementChecker
extends java.lang.Object

An abstract helper class for checking the completion of quest phase requirements.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
protected InventoryItemRemover	itemRemover The item remover to collect quest items.
protected java.util.List<java.lang.String>	itemStackLores The requirements, how they would appear on an item.
protected java.util.List<java.lang.String>	objectiveLores The requirements, how they would appear in the sidebar.
protected int	phase The quest phase to check requirements for.
protected org.bukkit.entity.Player	player The player that is doing the quest.
protected WauzQuest	quest The quest to check requirements for.
protected java.lang.String	trackerLocationString The location of the next objective for the quest tracker.
protected java.lang.String	trackerName The name of the next objective for the quest tracker.

Constructor Summary

Constructors

Constructor and Description
QuestRequirementChecker(org.bukkit.entity.Player player, WauzQuest quest, int phase) Initializes a new quest requirement checker.

Method Summary

Modifier and Type	Method and Description
abstract boolean	checkRequirements() Checks if the requirements have been fulfilled.
static QuestRequirementChecker	create(org.bukkit.entity.Player player, WauzQuest quest, int phase) Creates a quest requirement checker, based on the type of the phase.
protected abstract boolean	execute(boolean onlyObjectives) Checks the requirements of the quest and creates corresponding tracker locations and lore.
java.util.List<java.lang.String>	getItemStackLores()
java.util.List<java.lang.String>	getItemStackLoresUnaccepted()
java.util.List<java.lang.String>	getObjectiveLores(java.lang.String questMargin, org.bukkit.ChatColor questColor) Generates a list of a quest and its objectives, to show in the sidebar.
abstract void	handInItems() Hands in quest related items, if any were needed.
abstract void	initRequirements() Initializes configuration values for the requirements, if any are needed.
void	trackQuestObjective() Tracks the current quest objective, or the questgiver, if the quest hasn't started yet.

Methods inherited from class java.lang.Object

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

Field Detail

player

protected org.bukkit.entity.Player player

The player that is doing the quest.

quest

protected WauzQuest quest

The quest to check requirements for.

phase

protected int phase

The quest phase to check requirements for.

itemStackLores

protected java.util.List<java.lang.String> itemStackLores

The requirements, how they would appear on an item.

objectiveLores

protected java.util.List<java.lang.String> objectiveLores

The requirements, how they would appear in the sidebar.

trackerLocationString

protected java.lang.String trackerLocationString

The location of the next objective for the quest tracker.

trackerName

protected java.lang.String trackerName

The name of the next objective for the quest tracker.

itemRemover

protected InventoryItemRemover itemRemover

The item remover to collect quest items.

Constructor Detail

QuestRequirementChecker

public QuestRequirementChecker(org.bukkit.entity.Player player,
                               WauzQuest quest,
                               int phase)

Initializes a new quest requirement checker.

Parameters:

player - The player that is doing the quest.

quest - The quest to check requirements for.

phase - The quest phase to check requirements for.

Method Detail

create

public static QuestRequirementChecker create(org.bukkit.entity.Player player,
                                             WauzQuest quest,
                                             int phase)

Creates a quest requirement checker, based on the type of the phase.

Parameters:

player - The player that is doing the quest.

quest - The quest to check requirements for.

phase - The quest phase to check requirements for.

Returns:

The created requirement checker.

getItemStackLores

public java.util.List<java.lang.String> getItemStackLores()

Returns:

The requirements, how they would appear on an item.

getItemStackLoresUnaccepted

public java.util.List<java.lang.String> getItemStackLoresUnaccepted()

Returns:

The requirements, without current progress, how they would appear on an item.

getObjectiveLores

public java.util.List<java.lang.String> getObjectiveLores(java.lang.String questMargin,
                                                          org.bukkit.ChatColor questColor)

Generates a list of a quest and its objectives, to show in the sidebar.

Parameters:

questMargin - The empty space above the title.

questColor - The color of the quest type.

Returns:

The list of quest objectives.

trackQuestObjective

public void trackQuestObjective()

Tracks the current quest objective, or the questgiver, if the quest hasn't started yet.

See Also:

PlayerConfigurator.setTrackerDestination(Player, Location, String)

initRequirements

public abstract void initRequirements()

Initializes configuration values for the requirements, if any are needed.

checkRequirements

public abstract boolean checkRequirements()

Checks if the requirements have been fulfilled.

Returns:

If the requirements were fulfilled.

handInItems

public abstract void handInItems()

Hands in quest related items, if any were needed.

execute

protected abstract boolean execute(boolean onlyObjectives)

Checks the requirements of the quest and creates corresponding tracker locations and lore.

Parameters:

onlyObjectives - If only objectives and no progress should appear in the lore.

Returns:

If the quest phase is completed.