com.TeamHEC.LocomotionCommotion.Goal

Class Goal

java.lang.Object

com.TeamHEC.LocomotionCommotion.Goal.Goal

All Implemented Interfaces:

RouteListener

Direct Known Subclasses:

SpecialGoal

public class Goal
extends java.lang.Object
implements RouteListener

Author:

Sam Anderson , Matthew Taylor , Stefan Kokov

Field Summary

Fields

Modifier and Type	Field and Description
static GoalActor	goalActor

Constructor Summary

Constructors

Constructor and Description
Goal(org.json.simple.JSONObject goalJSON)
Goal(Station startStation, Station finalStation, int noOfStations, java.lang.String cargo, int reward) Initializes the goal.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignTrain(Train train) Assigns a goal to a train and registers listeners
int	calculatePoints() Used to calculate how many points to add to a player's score upon completion of goal EstimateOptimalDuration = how many turns it would take train to travel goal's optimal route at base speed CurrentGoalDuration = how many turns it actually took the train reward = length of optimal journey
int	estimateOptimalDuration() Used to estimate how many turns it would take the train (assigned to the goal) to travel the goal's optimal route at its base speed
java.lang.String	getCargo()
int	getCurrentGoalDuration()
java.lang.String	getFStation()
Station	getFStationObject()
int	getReward()
java.lang.String	getSStation()
Station	getSStationObject()
java.lang.String	getStartDate()
int	getTimeConstraint()
java.lang.String	getTimeConstraintString() Returns the number of stations a player ha to pass through.
Train	getTrain()
java.lang.Boolean	goalComplete() Called when the goal is successfully complete
void	goalFailed() Called when the goal is failed (only quantifiable goals can be failed)
void	incrementCurrentGoalDuration() Should be called at the end of each turn
boolean	isAbsolute()
boolean	isQuantifiable()
boolean	isSpecial()
void	setActor(GoalActor actor)
void	setSpecial(boolean special)
void	setTimeConstraint(int timeConstraint)
void	stationPassed(Station station, Train train) Listener trigger when a train passes a station
java.lang.String	toJSON()

Methods inherited from class java.lang.Object

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

Field Detail

goalActor

public static GoalActor goalActor

Constructor Detail

Goal

public Goal(org.json.simple.JSONObject goalJSON)

Goal

public Goal(Station startStation,
    Station finalStation,
    int noOfStations,
    java.lang.String cargo,
    int reward)

Initializes the goal.

Parameters:

startStation - The Station the goal starts from

finalStation - The Station the goal ends at

noOfStations - The maximum number of station the train should pass. Value 0 means there is no time constraint.

cargo - The type of cargo the train is carrying. (Currently not used)

reward - The reward (currently Gold) you get for completing the Goal

Method Detail

toJSON

public java.lang.String toJSON()

isSpecial

public boolean isSpecial()

getSStation

public java.lang.String getSStation()

getSStationObject

public Station getSStationObject()

getFStation

public java.lang.String getFStation()

getFStationObject

public Station getFStationObject()

getReward

public int getReward()

getStartDate

public java.lang.String getStartDate()

setActor

public void setActor(GoalActor actor)

getCargo

public java.lang.String getCargo()

assignTrain

public void assignTrain(Train train)

Assigns a goal to a train and registers listeners

Parameters:

train - The train to assign to

getTrain

public Train getTrain()

goalComplete

public java.lang.Boolean goalComplete()

Called when the goal is successfully complete

Returns:

False if goal is not ready to complete

goalFailed

public void goalFailed()

Called when the goal is failed (only quantifiable goals can be failed)

stationPassed

public void stationPassed(Station station,
                 Train train)

Listener trigger when a train passes a station

Specified by:

stationPassed in interface RouteListener

setSpecial

public void setSpecial(boolean special)

getCurrentGoalDuration

public int getCurrentGoalDuration()

incrementCurrentGoalDuration

public void incrementCurrentGoalDuration()

Should be called at the end of each turn

calculatePoints

public int calculatePoints()

Used to calculate how many points to add to a player's score upon completion of goal EstimateOptimalDuration = how many turns it would take train to travel goal's optimal route at base speed CurrentGoalDuration = how many turns it actually took the train reward = length of optimal journey

Returns:

0 if goal is not yet completed, otherwise number of points

estimateOptimalDuration

public int estimateOptimalDuration()

Used to estimate how many turns it would take the train (assigned to the goal) to travel the goal's optimal route at its base speed

Returns:

0 if no train has been assigned, otherwise it will return "optimal" number of turns for completion

isQuantifiable

public boolean isQuantifiable()

isAbsolute

public boolean isAbsolute()

getTimeConstraintString

public java.lang.String getTimeConstraintString()

Returns the number of stations a player ha to pass through. Returns "Any" if StationVia is null.

Returns:

The route string that is displayed on the ticket ("via n stations" if quantifiable, or "Any" if absolute)

getTimeConstraint

public int getTimeConstraint()

setTimeConstraint

public void setTimeConstraint(int timeConstraint)