com.codingame.gameengine.core

Class GameManager<T extends AbstractPlayer>

java.lang.Object

com.codingame.gameengine.core.GameManager<T>

Type Parameters:

T - Your implementation of AbstractPlayer

public final class GameManager<T extends AbstractPlayer>
extends java.lang.Object

The GameManager takes care of running each turn of the game and computing each visual frame of the replay. It provides many utility methods that handle instances of your implementation of AbstractPlayer.

Constructor Summary

Constructors

Constructor and Description
GameManager()

Method Summary

Modifier and Type	Method and Description
void	addToGameSummary(java.lang.String summary) Add a new line to the game summary for the current turn.
void	addTooltip(AbstractPlayer player, java.lang.String message) Adds a tooltip for the current turn.
void	addTooltip(Tooltip tooltip) Adds a tooltip for the current turn.
void	endGame() Set game end.
static java.lang.String	formatErrorMessage(java.lang.String message) Helper function to display a colored message.
static java.lang.String	formatSuccessMessage(java.lang.String message) Helper function to display a colored message.
java.util.List<T>	getActivePlayers() Get all the active players.
int	getFrameDuration() Returns the duration in milliseconds for the frame currently being computed.
int	getLeagueLevel() Get current league level.
int	getMaxTurns() Get the maximum amount of turns.
T	getPlayer(int i) Get player with index i
int	getPlayerCount() Get initial number of players.
java.util.List<T>	getPlayers() Get all the players.
int	getTurnMaxTime() Get the timeout delay for every players.
boolean	isGameEnd() Check if the game has been terminated by the referee.
void	registerModule(Module m) Register a module to the gameManager.
void	setFrameDuration(int frameDuration) Specifies the frameDuration in milliseconds.
void	setMaxTurns(int maxTurns) Set the maximum amount of turns.
void	setTurnMaxTime(int turnMaxTime) Set the timeout delay for every players.
void	setViewData(java.lang.Object data) Set data for use by the viewer, for the current frame.
void	setViewData(java.lang.String moduleName, java.lang.Object data) Set data for use by the viewer, for the current frame, for a specific module.
void	setViewGlobalData(java.lang.String moduleName, java.lang.Object data) Set data for use by the viewer and not related to a specific frame.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameManager

public GameManager()

Method Detail

getPlayerCount

public int getPlayerCount()

Get initial number of players.

Returns:

the number of players.

getPlayers

public java.util.List<T> getPlayers()

Get all the players.

Returns:

the list of players.

getActivePlayers

public java.util.List<T> getActivePlayers()

Get all the active players.

Returns:

the list of active players.

getPlayer

public T getPlayer(int i)
            throws java.lang.IndexOutOfBoundsException

Get player with index i

Parameters:

i - Player index

Returns:

player with index i

Throws:

java.lang.IndexOutOfBoundsException

setFrameDuration

public void setFrameDuration(int frameDuration)

Specifies the frameDuration in milliseconds. Default: 1000ms

Parameters:

frameDuration - The frame duration in milliseconds.

getFrameDuration

public int getFrameDuration()

Returns the duration in milliseconds for the frame currently being computed.

Returns:

the frame duration in milliseconds.

endGame

public void endGame()

Set game end.

isGameEnd

public boolean isGameEnd()

Check if the game has been terminated by the referee.

Returns:

true if the game is over.

setMaxTurns

public void setMaxTurns(int maxTurns)
                 throws java.lang.IllegalStateException,
                        java.lang.IllegalArgumentException

Set the maximum amount of turns. Default: 400.

Parameters:

maxTurns - the number of turns for a game.

Throws:

java.lang.IllegalStateException

java.lang.IllegalArgumentException

getMaxTurns

public int getMaxTurns()

Get the maximum amount of turns.

Returns:

the maximum number of turns.

setTurnMaxTime

public void setTurnMaxTime(int turnMaxTime)
                    throws java.lang.IllegalArgumentException

Set the timeout delay for every players. This value can be updated during a game and will be used by execute(). Default is 50ms.

Parameters:

turnMaxTime - Duration in milliseconds.

Throws:

java.lang.IllegalArgumentException

getTurnMaxTime

public int getTurnMaxTime()

Get the timeout delay for every players.

Returns:

the current timeout duration in milliseconds.

setViewData

public void setViewData(java.lang.Object data)

Set data for use by the viewer, for the current frame.

Parameters:

data - any object that can be serialized in JSON using gson.

setViewData

public void setViewData(java.lang.String moduleName,
                        java.lang.Object data)

Set data for use by the viewer, for the current frame, for a specific module.

Parameters:

moduleName - the name of the module

data - any object that can be serialized in JSON using gson.

setViewGlobalData

public void setViewGlobalData(java.lang.String moduleName,
                              java.lang.Object data)

Set data for use by the viewer and not related to a specific frame. This must be use in the init only.

Parameters:

moduleName - the name of the module

data - any object that can be serialized in JSON using gson.

addTooltip

public void addTooltip(Tooltip tooltip)

Adds a tooltip for the current turn.

Parameters:

tooltip - A tooltip that will be shown in the player.

addTooltip

public void addTooltip(AbstractPlayer player,
                       java.lang.String message)

Adds a tooltip for the current turn.

Parameters:

player - The player the tooltip information is about.

message - Tooltip message.

addToGameSummary

public void addToGameSummary(java.lang.String summary)

Add a new line to the game summary for the current turn.

Parameters:

summary - summary line to add to the current summary.

registerModule

public void registerModule(Module m)

Register a module to the gameManager. After this, the gameManager will call the module callbacks automatically.

Parameters:

m -

getLeagueLevel

public int getLeagueLevel()

Get current league level. The value can be set by using -Dleague.level=X where X is the league level.

Returns:

a strictly positive integer. 1 is the lowest level and default value.

formatSuccessMessage

public static java.lang.String formatSuccessMessage(java.lang.String message)

Helper function to display a colored message. Usually used at the end of the game.

Parameters:

message - The message to display.

Returns:

The formatted string.

formatErrorMessage

public static java.lang.String formatErrorMessage(java.lang.String message)

Helper function to display a colored message. Usually used at the end of the game.

Parameters:

message - The message to display.

Returns:

The formatted string.