com.codingame.gameengine.core

Class AbstractPlayer

java.lang.Object

com.codingame.gameengine.core.AbstractPlayer

public abstract class AbstractPlayer
extends java.lang.Object

The representation of the a player's AI during the game's execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPlayer.TimeoutException An Exception thrown by getOutputs() when the player's AI did not respond in time after an execute().

Constructor Summary

Constructors

Constructor and Description
AbstractPlayer()

Method Summary

Modifier and Type	Method and Description
void	deactivate() Deactivate a player.
void	deactivate(java.lang.String reason) Deactivate a player and adds a tooltip with the reason.
void	execute() Executes the player for a maximum of turnMaxTime milliseconds and store the output.
java.lang.String	getAvatarToken() Returns a string that will be converted into the real avatar by the viewer, if it exists.
int	getColorToken() Returns an integer that will be converted into the player's real color by the viewer.
abstract int	getExpectedOutputLines() Returns the number of lines that the player must return.
int	getIndex() Get player index from 0 (included) to number of players (excluded).
java.lang.String	getNicknameToken() Returns a string that will be converted into the real nickname by the viewer.
java.util.List<java.lang.String>	getOutputs() Gets the output obtained after an execution.
int	getScore() Get current score.
boolean	isActive() Returns true is the player is still active in the game (can be executed).
void	sendInputLine(java.lang.String line) Adds a new line to the input to send to the player on execute.
void	setScore(int score) Set current score.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlayer

public AbstractPlayer()

Method Detail

getNicknameToken

public final java.lang.String getNicknameToken()

Returns a string that will be converted into the real nickname by the viewer.

Returns:

the player's nickname token.

getColorToken

public final int getColorToken()

Returns an integer that will be converted into the player's real color by the viewer.

Returns:

the player's color token.

getAvatarToken

public final java.lang.String getAvatarToken()

Returns a string that will be converted into the real avatar by the viewer, if it exists.

Returns:

the player's avatar token.

isActive

public final boolean isActive()

Returns true is the player is still active in the game (can be executed).

Returns:

true is the player is active.

getIndex

public final int getIndex()

Get player index from 0 (included) to number of players (excluded).

Returns:

the player index.

getScore

public final int getScore()

Get current score.

Returns:

current player score

setScore

public final void setScore(int score)

Set current score. This is used to rank the players at the end of the game.

Parameters:

score -

deactivate

public final void deactivate()

Deactivate a player. The player can't play after this and is no longer in the list of active players.

deactivate

public final void deactivate(java.lang.String reason)

Deactivate a player and adds a tooltip with the reason. The player can't play after this and is no longer in the list of active players.

Parameters:

reason - Message to display in the tooltip.

sendInputLine

public final void sendInputLine(java.lang.String line)

Adds a new line to the input to send to the player on execute.

Parameters:

line - The input to send.

execute

public final void execute()

Executes the player for a maximum of turnMaxTime milliseconds and store the output.

getOutputs

public final java.util.List<java.lang.String> getOutputs()
                                                  throws AbstractPlayer.TimeoutException

Gets the output obtained after an execution.

Returns:

a list of output lines

Throws:

AbstractPlayer.TimeoutException

getExpectedOutputLines

public abstract int getExpectedOutputLines()

Returns the number of lines that the player must return. If the player do not write that amount of lines before the timeout delay, no outputs at all will be available for this player. The game engine will not read more than the expected output lines. Extra lines will be available for next turn.

Returns:

the expected amount of lines the player must output