Package com.csse3200.game.missions.achievements

Class PlantCropsAchievement

java.lang.Object

com.csse3200.game.missions.Mission

com.csse3200.game.missions.achievements.Achievement

com.csse3200.game.missions.achievements.PlantCropsAchievement

public class PlantCropsAchievement
extends Achievement

An Achievement completed by planting a certain number of crops on crop tiles.

Constructor Summary

Constructors

Constructor	Description
PlantCropsAchievement(String name, int numberOfCropsToPlant)	Creates a PlantCropsAchievement.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a description of the PlantCropsAchievement with the name of the achievement and the player's progress.
Object	getProgress()	Gives the progress of the PlantCropsAchievement
String	getShortDescription()	Gives a short description of the PlantCropsAchievement showing the player's progress in the achievement.
boolean	isCompleted()	Returns true if the number of crops the player has planted is greater than or equal to the target number of plants.
void	readProgress(com.badlogic.gdx.utils.JsonValue progress)	Reads in the progress of the PlantCropsAchievement from a JsonValue.
void	registerMission(EventHandler missionManagerEvents)	Registers the PlantCropsAchievement with the MissionManager by adding a listener to the PLANT_CROP MissionManager.MissionEvent
protected void	updateState(String ignored)	Increments the number of plants the player has planted.

Methods inherited from class com.csse3200.game.missions.achievements.Achievement

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

PlantCropsAchievement

public PlantCropsAchievement(String name,
 int numberOfCropsToPlant)

Creates a PlantCropsAchievement.

Parameters:

name - The name of the PlantCropsAchievement

numberOfCropsToPlant - The target number of crops to plant to reach this achievement

Method Details

registerMission

public void registerMission(EventHandler missionManagerEvents)

Registers the PlantCropsAchievement with the MissionManager by adding a listener to the PLANT_CROP 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()

Returns true if the number of crops the player has planted is greater than or equal to the target number of plants.

Specified by:

isCompleted in class Mission

Returns:

True if the player has planted the target number of plants.

getDescription

public String getDescription()

Returns a description of the PlantCropsAchievement with the name of the achievement and the player's progress.

Specified by:

getDescription in class Mission

Returns:

- the PlantCropsAchievement's description

getShortDescription

public String getShortDescription()

Gives a short description of the PlantCropsAchievement showing the player's progress in the achievement.

Specified by:

getShortDescription in class Mission

Returns:

- short description of the PlantCropsAchievement

readProgress

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

Reads in the progress of the PlantCropsAchievement 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()

Gives the progress of the PlantCropsAchievement

Specified by:

getProgress in class Mission

Returns:

- the number of crops the player has planted since creation of the PlantCropsAchievement.

updateState

protected void updateState(String ignored)

Increments the number of plants the player has planted.

Parameters:

ignored - The String representation of the plant type. Irrelevant for this Achievement.