com.TeamHEC.LocomotionCommotion.Obstacle

Class Obstacle

java.lang.Object

com.TeamHEC.LocomotionCommotion.Obstacle.Obstacle

public class Obstacle
extends java.lang.Object

This class represents an Obstacle that can occur to a train during the Game.

Author:

Alfio E. Fresta

Constructor Summary

Constructors

Constructor and Description
Obstacle(java.lang.String name, java.lang.String description, double speedFactor, int noTurns)
Obstacle(java.lang.String name, java.lang.String description, double speedFactor, int noTurns, Train target) Instantiates a new obstacle and applies it to a train

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTo(Train t) Applies the obstacle to a train.
java.lang.String	getDescription()
java.lang.String	getName()
double	getSpeedFactor() Returns the speed factor for the obstacle
int	getTurnsElapsed() Returns the number of turns the obstacle has already been effective for
int	getTurnsLeft() Returns the number of turns left for this obstacle.
boolean	isActive() Checks whether the obstacle has been assigned to a Train yet.
void	startTurn() Increments the internal counter, eventually destroys itself and disassociate from the Train if the number of turn left is equal to zero.
java.lang.String	toJSON()

Methods inherited from class java.lang.Object

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

Constructor Detail

Obstacle

public Obstacle(java.lang.String name,
        java.lang.String description,
        double speedFactor,
        int noTurns)

Obstacle

public Obstacle(java.lang.String name,
        java.lang.String description,
        double speedFactor,
        int noTurns,
        Train target)

Instantiates a new obstacle and applies it to a train

Parameters:

name -

description -

speedFactor -

noTurns -

target -

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

applyTo

public void applyTo(Train t)

Applies the obstacle to a train.

Parameters:

t - The train to apply the obstacle to.

isActive

public boolean isActive()

Checks whether the obstacle has been assigned to a Train yet.

Returns:

Yes or no.

getTurnsLeft

public int getTurnsLeft()

Returns the number of turns left for this obstacle.

Returns:

No. of turns left for the obstacle.

getTurnsElapsed

public int getTurnsElapsed()

Returns the number of turns the obstacle has already been effective for

Returns:

No. of turns the obstacle

getSpeedFactor

public double getSpeedFactor()

Returns the speed factor for the obstacle

Returns:

A factor from 0 to 1 that should be multiplied by the train speed.

startTurn

public void startTurn()

Increments the internal counter, eventually destroys itself and disassociate from the Train if the number of turn left is equal to zero.

toJSON

public java.lang.String toJSON()