GameManager (CodinGame Game Engine Core 2.2 API)

java.lang.Object
- com.codingame.gameengine.core.GameManager<T>

Type Parameters:

T - Your implementation of AbstractPlayer

Direct Known Subclasses:

MultiplayerGameManager, SoloGameManager
```
public abstract class GameManager<T extends AbstractPlayer>
extends 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.

Field Summary

Fields
Modifier and Type Field and Description

protected static org.apache.commons.logging.Log log

protected PrintStream out

protected List<T> players

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log`
`protected PrintStream`	`out`
`protected List<T>`	`players`

Constructor Summary

Constructors
Constructor and Description

GameManager()

Constructors
Constructor and Description
`GameManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToGameSummary(String summary)` Add a new line to the game summary for the current turn.
`void`	`addTooltip(AbstractPlayer player, String message)` Adds a tooltip for the current turn.
`void`	`addTooltip(Tooltip tooltip)` Adds a tooltip for the current turn.
`protected abstract boolean`	`allPlayersInactive()`
`protected void`	`dumpGameProperties()`
`protected void`	`endGame()` Set game end.
`static String`	`formatErrorMessage(String message)` Helper function to display a colored message.
`static String`	`formatSuccessMessage(String message)` Helper function to display a colored message.
`int`	`getFrameDuration()` Returns the duration in milliseconds for the frame currently being computed.
`protected abstract com.codingame.gameengine.core.OutputCommand`	`getGameSummaryOutputCommand()`
`int`	`getLeagueLevel()` Get current league level.
`int`	`getMaxTurns()` Get the maximum amount of turns.
`int`	`getTurnMaxTime()` Get the timeout delay for every players.
`boolean`	`isGameEnd()` Check if the game has been terminated by the referee.
`void`	`putMetadata(String key, String value)` Puts a new metadata that will be sent to the CodinGame IDE.
`protected abstract void`	`readGameProperties(com.codingame.gameengine.core.InputCommand iCmd, Scanner s)`
`void`	`registerModule(Module module)` 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(Object data)` Set data for use by the viewer, for the current frame.
`void`	`setViewData(String moduleName, Object data)` Set data for use by the viewer, for the current frame, for a specific module.
`void`	`setViewGlobalData(String moduleName, Object data)` Set data for use by the viewer and not related to a specific frame.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
protected static org.apache.commons.logging.Log log
```
  - players
```
protected List<T extends AbstractPlayer> players
```
  - out
```
protected PrintStream out
```
- Constructor Detail
  - GameManager
```
public GameManager()
```
- Method Detail
  - allPlayersInactive
```
protected abstract boolean allPlayersInactive()
```
  - readGameProperties
```
protected abstract void readGameProperties(com.codingame.gameengine.core.InputCommand iCmd,
                                           Scanner s)
```
  - dumpGameProperties
```
protected void dumpGameProperties()
```
  - getGameSummaryOutputCommand
```
protected abstract com.codingame.gameengine.core.OutputCommand getGameSummaryOutputCommand()
```
  - putMetadata
```
public final void putMetadata(String key,
                              String value)
```
    Puts a new metadata that will be sent to the CodinGame IDE.
    
    Parameters:
    
    key - the property to send
    
    value - the property's value
  - 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
```
protected 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 IllegalArgumentException
```
    Set the maximum amount of turns. Default: 400.
    
    Parameters:
    
    maxTurns - the number of turns for a game.
    
    Throws:
    
    IllegalArgumentException - if maxTurns ≤ 0
  - getMaxTurns
```
public int getMaxTurns()
```
    Get the maximum amount of turns.
    
    Returns:
    
    the maximum number of turns.
  - setTurnMaxTime
```
public void setTurnMaxTime(int turnMaxTime)
                    throws 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:
    
    IllegalArgumentException - if turnMaxTime ≤ 0
  - getTurnMaxTime
```
public int getTurnMaxTime()
```
    Get the timeout delay for every players.
    
    Returns:
    
    the current timeout duration in milliseconds.
  - setViewData
```
public void setViewData(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(String moduleName,
                        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(String moduleName,
                              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,
                       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(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 module)
```
    Register a module to the gameManager. After this, the gameManager will call the module callbacks automatically.
    
    Parameters:
    
    module - the module to register
  - 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 String formatSuccessMessage(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 String formatErrorMessage(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.

Class GameManager<T extends AbstractPlayer>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

players

out

Constructor Detail

GameManager

Method Detail

allPlayersInactive

readGameProperties

dumpGameProperties

getGameSummaryOutputCommand

putMetadata

setFrameDuration

getFrameDuration

endGame

isGameEnd

setMaxTurns

getMaxTurns

setTurnMaxTime

getTurnMaxTime

setViewData

setViewData

setViewGlobalData

addTooltip

addTooltip

addToGameSummary

registerModule

getLeagueLevel

formatSuccessMessage

formatErrorMessage