ihs.apcs.spacebattle

Interface Spaceship<T>

Type Parameters:

T - the Game class being used by the server. Will correspond to the type of information retrieved by the Environment class.

All Known Implementing Classes:

BasicSpaceship

public interface Spaceship<T>

Represents a ship in the Space Battle world.

Spaceship's are autonomous and issue commands through callbacks to the server using this class's methods. The flow operations is as follows:

1. Client connects to the server
2. Server requests registration
3. Client calls registerShip(int, int, int) to get registration information and forwards registration to the server
4. Server responds by sending back an Environment and waiting for a command
5. Client calls getNextCommand(Environment) and sends the returned command back to the server
6. Repeat 4-5

Since:

0.1

Method Summary

Methods

Modifier and Type	Method and Description
ShipCommand	getNextCommand(Environment<T> env) Issues a command to be executed by this ship on the server.
RegistrationData	registerShip(int numImages, int worldWidth, int worldHeight) Registers a ship with the server so it can begin issuing commands.
void	shipDestroyed(java.lang.String lastDestroyedBy) Notifies a ship that it has been destroyed and respawned.

Method Detail

registerShip

RegistrationData registerShip(int numImages,
                            int worldWidth,
                            int worldHeight)

Registers a ship with the server so it can begin issuing commands.

Parameters:

numImages - the number of images available for the ship's appearance on the server

worldWidth - the width of the current world in pixels

worldHeight - the height of the current world in pixels

Returns:

the necessary registration information for the server

getNextCommand

ShipCommand getNextCommand(Environment<T> env)

Issues a command to be executed by this ship on the server.

Commands are executed one at a time, except for non-blocking commands. Commands cannot be issued except when requested by the server. The server will process each command, then send the new environment (representing the result of the issued command and any actions taken by other entities in the game world) back to the ship and request a new command.

Parameters:

env - the current environment provided by the server

Returns:

a command to be executed by the ship

shipDestroyed

void shipDestroyed(java.lang.String lastDestroyedBy)

Notifies a ship that it has been destroyed and respawned. Ships can use this to track their deaths.

Parameters:

lastDestroyedBy - string containing the name of the player's ship or the object type name and #ID of the entity which destroyed your ship.

Since:

0.95