com.TeamHEC.LocomotionCommotion.Train

Class Train

java.lang.Object

com.TeamHEC.LocomotionCommotion.Train.Train

Direct Known Subclasses:

CoalTrain, ElectricTrain, NuclearTrain, OilTrain

public abstract class Train
extends java.lang.Object

Author:

Matthew Taylor

Field Summary

Fields

Modifier and Type	Field and Description
int	fuelPerTurn
Route	route

Constructor Summary

Constructors

Constructor and Description
Train(java.lang.String name, Fuel fuelType, int baseSpeed, int speedMod, int value, boolean inStation, Route route, Player owner) The superclass of Train types, Creates a Train for player.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUpgrade(TrainUpgrade upgrade) Adds an upgrade to the current train:
void	decreaseFuelPerTurn(int by)
Game_Map_Train	getActor()
int	getBaseSpeed()
int	getFuelLengthCost(float length)
int	getFuelPerTurn()
int	getFuelRouteCost()
java.lang.String	getFuelType()
java.lang.String	getName()
Obstacle	getObstacle()
double	getObstacleSpeedFactor()
Player	getOwner()
Route	getRoute()
int	getSpeed() Returns the speed of the train.
int	getSpeedMod()
int	getValue()
boolean	hasObstacle()
void	increaseSpeedMod(int by)
void	instantMoveTrain() Instantly completes the trains movement for this turn
boolean	isInStation()
void	moveTrain() Moves the train through it's route
void	removeUpgrade(TrainUpgrade upgrade) Removes an upgrade from a train
void	setFuelPerTurn(int fuelPerTurn)
void	setInStation(boolean inStation)
void	setObstacle(Obstacle o)
void	setSpeedMod(int speedMod)
java.lang.String	toJSON()

Methods inherited from class java.lang.Object

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

Field Detail

fuelPerTurn

public int fuelPerTurn

route

public final Route route

Constructor Detail

Train

public Train(java.lang.String name,
     Fuel fuelType,
     int baseSpeed,
     int speedMod,
     int value,
     boolean inStation,
     Route route,
     Player owner)

The superclass of Train types, Creates a Train for player.

Parameters:

fuelType - Type of fuel the train consumes

speedMod - Any speed modifications made to the train

value - The price of the train

inStation - whether the train is currently in a station

route - The route the train is currently using

owner - The owner of the train

Method Detail

toJSON

public java.lang.String toJSON()

getActor

public Game_Map_Train getActor()

Returns:

The Actor (UI Element) for the train

getName

public java.lang.String getName()

getValue

public int getValue()

getOwner

public Player getOwner()

getSpeed

public int getSpeed()

Returns the speed of the train. Accounts for speed modifiers and obstacles.

getBaseSpeed

public int getBaseSpeed()

getSpeedMod

public int getSpeedMod()

getObstacleSpeedFactor

public double getObstacleSpeedFactor()

getFuelPerTurn

public int getFuelPerTurn()

getFuelRouteCost

public int getFuelRouteCost()

Returns:

The amount of fuel for the remaining route:

getFuelLengthCost

public int getFuelLengthCost(float length)

Parameters:

length - the length of distance you want to travel

Returns:

The amount of fuel needed to travel that distance

getFuelType

public java.lang.String getFuelType()

Returns:

A string of the fuel used by a train:

getRoute

public Route getRoute()

setSpeedMod

public void setSpeedMod(int speedMod)

setFuelPerTurn

public void setFuelPerTurn(int fuelPerTurn)

increaseSpeedMod

public void increaseSpeedMod(int by)

decreaseFuelPerTurn

public void decreaseFuelPerTurn(int by)

setInStation

public void setInStation(boolean inStation)

isInStation

public boolean isInStation()

moveTrain

public void moveTrain()

Moves the train through it's route

instantMoveTrain

public void instantMoveTrain()

Instantly completes the trains movement for this turn

addUpgrade

public void addUpgrade(TrainUpgrade upgrade)

Adds an upgrade to the current train:

Parameters:

upgrade - The upgrade to be added

removeUpgrade

public void removeUpgrade(TrainUpgrade upgrade)

Removes an upgrade from a train

Parameters:

upgrade - the upgrade to be removed

hasObstacle

public boolean hasObstacle()

getObstacle

public Obstacle getObstacle()

setObstacle

public void setObstacle(Obstacle o)