toroidwars.interfaces
Interface Player

All Known Implementing Classes:
BasePlayer, NeutralPlayer

public interface Player

Author:
Kent McClymont, Maximillian Dupenois and Maximillian Dupenois

Method Summary
 Log getLog()
          Returns the current log
 java.lang.String getName()
          Returns the name
 void initialise(WorldMap map, int totalTurns)
          Called at game initialisation, gives a world map
 void takeTurn(int turn, Country[] countries)
          Called for a player to make a turn.
 void turnTimedOut(int turn)
          Called if the current turn has timedout
 

Method Detail

initialise

void initialise(WorldMap map,
                int totalTurns)
Called at game initialisation, gives a world map

Parameters:
map - the world map
totalTurns - the number of total turns the game has

takeTurn

void takeTurn(int turn,
              Country[] countries)
Called for a player to make a turn. to make a turn on a country a player has to perform country.[turntype] i.e. country.build()

Parameters:
turn - the current turn number
countries - the countries owned by the plater

turnTimedOut

void turnTimedOut(int turn)
Called if the current turn has timedout

Parameters:
turn - the turn that ahas timed out

getLog

Log getLog()
Returns the current log

Returns:
the current log

getName

java.lang.String getName()
Returns the name

Returns:
the player name