Package com.csse3200.game.missions.quests

Class TameAnimalsQuest

java.lang.Object

com.csse3200.game.missions.Mission

com.csse3200.game.missions.quests.Quest

com.csse3200.game.missions.quests.TameAnimalsQuest

public class TameAnimalsQuest
extends Quest

A Quest where the player must tame animals

Constructor Summary

Constructors

Constructor	Description
TameAnimalsQuest(String name, Reward reward, int numberOfAnimalsToTame)	Creates a TameAnimalsQuest
TameAnimalsQuest(String name, Reward reward, int expiryDuration, int numberOfAnimalsToTame)	Creates a TameAnimalsQuest with an expiry

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets a description of the TameAnimalsQuest
Object	getProgress()	Gets the TameAnimalsQuest's progress
String	getShortDescription()	Gets a short descritiopn of the TameAnimalsQuest
boolean	isCompleted()	Checks if the TameAnimalsQuest is complete
void	readProgress(com.badlogic.gdx.utils.JsonValue progress)	Reads in the current TameAnimalsQuest from a JsonValue
void	registerMission(EventHandler missionManagerEvents)	Register the TameAnimalsQuest with the MissionManager by adding listener to the ANIMAL_TAMED MissionManager.MissionEvent
protected void	resetState()	Resets number of animals tamed back to 0

Methods inherited from class com.csse3200.game.missions.quests.Quest

collectReward, isExpired, isMandatory, isRewardCollected, read, resetExpiry, updateExpiry, write

Methods inherited from class com.csse3200.game.missions.Mission

getName, notifyUpdate

Methods inherited from class java.lang.Object

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

Constructor Details

TameAnimalsQuest

public TameAnimalsQuest(String name,
 Reward reward,
 int numberOfAnimalsToTame)

Creates a TameAnimalsQuest

Parameters:

name - Name of the quest

reward - Reward the player can collect on completion

numberOfAnimalsToTame - Number of animals the player must claim

TameAnimalsQuest

public TameAnimalsQuest(String name,
 Reward reward,
 int expiryDuration,
 int numberOfAnimalsToTame)

Creates a TameAnimalsQuest with an expiry

Parameters:

name - Name of the quest

reward - Reward the player can collect on completion

expiryDuration - How long until the TameAnimalsQuest

numberOfAnimalsToTame - Number of animals the player must claim

Method Details

registerMission

public void registerMission(EventHandler missionManagerEvents)

Register the TameAnimalsQuest with the MissionManager by adding listener to the ANIMAL_TAMED MissionManager.MissionEvent

Specified by:

registerMission in class Mission

Parameters:

missionManagerEvents - A reference to the EventHandler on the MissionManager, with which relevant events should be listened to.

isCompleted

public boolean isCompleted()

Checks if the TameAnimalsQuest is complete

Specified by:

isCompleted in class Mission

Returns:

Returns true iff the player has tamed at least the target amount of animals

getDescription

public String getDescription()

Gets a description of the TameAnimalsQuest

Specified by:

getDescription in class Mission

Returns:

The quest's description

getShortDescription

public String getShortDescription()

Gets a short descritiopn of the TameAnimalsQuest

Specified by:

getShortDescription in class Mission

Returns:

The TameAnimalsQuest's short description with its progress

readProgress

public void readProgress(com.badlogic.gdx.utils.JsonValue progress)

Reads in the current TameAnimalsQuest from a JsonValue

Specified by:

readProgress in class Mission

Parameters:

progress - The JsonValue representing the progress of the Mission as determined by the value returned in getProgress().

getProgress

public Object getProgress()

Gets the TameAnimalsQuest's progress

Specified by:

getProgress in class Mission

Returns:

The number of animals the player has currently tamed

resetState

protected void resetState()

Resets number of animals tamed back to 0

Specified by:

resetState in class Quest