ihs.apcs.spacebattle

Class Environment<T>

java.lang.Object

ihs.apcs.spacebattle.Environment<T>

Type Parameters:

T - specify the corresponding Game class to that being played on the server. Corresponds to the same class used by the Spaceship interface.

Direct Known Subclasses:

BasicEnvironment

public class Environment<T>
extends java.lang.Object

A class to represent the state of the world at the time a command is requested. An Environment is passed to the Spaceship.getNextCommand(Environment) method of the Spaceship class to inform the ship of the current state of your ship and the world. The Environment may contain additional information based on performing other commands like RadarCommand.

Since:

0.1

Constructor Summary

Constructors

Constructor and Description
Environment()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Environment<T> other) Determines if this Environment is the same as another one.
T	getGameInfo() Gets information concerning the current game objective.
java.lang.String[]	getMessages() Gets a list of messages currently received.
RadarResults	getRadar() Gets the results of the most recent radar sweep, if and only if the last command issued was a RadarCommand.
int	getRadarLevel() Gets the level of the last radar sweep, if the last command issued was a RadarCommand.
ObjectStatus	getShipStatus() Gets the status of your ship.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment()

Method Detail

getMessages

public java.lang.String[] getMessages()

Gets a list of messages currently received. [Not Used]

Returns:

a list of messages

getRadarLevel

public int getRadarLevel()

Gets the level of the last radar sweep, if the last command issued was a RadarCommand.

Returns:

the level of radar sweep performed by the RadarCommand.

getRadar

public RadarResults getRadar()

Gets the results of the most recent radar sweep, if and only if the last command issued was a RadarCommand.

Returns:

results of the radar sweep performed with the last RadarCommand, or null if the last command issued was not a radar sweep

getShipStatus

public ObjectStatus getShipStatus()

Gets the status of your ship.

Returns:

the status of your ship

getGameInfo

public T getGameInfo()

Gets information concerning the current game objective.

Returns:

information about the current game, or null if no game is in progress

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(Environment<T> other)

Determines if this Environment is the same as another one. Two Environments are equal if they contain all the same data.

Parameters:

other - the Environment to compare to

Returns:

true if the Environments are equal, false otherwise