Package dev.robocode.tankroyale.botapi
Class GameSetup
- java.lang.Object
-
- dev.robocode.tankroyale.botapi.GameSetup
-
public final class GameSetup extends java.lang.Object
Game setup retrieved when game is started.
-
-
Constructor Summary
Constructors Constructor Description GameSetup(java.lang.String gameType, int arenaWidth, int arenaHeight, int numberOfRounds, double gunCoolingRate, int maxInactivityTurns, int turnTimeout, int readyTimeout)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getArenaHeight()
Returns the height of the arena measured in units.int
getArenaWidth()
Returns the width of the arena measured in units.java.lang.String
getGameType()
Returns the game type, e.g.double
getGunCoolingRate()
Returns the gun cooling rate.int
getMaxInactivityTurns()
Returns the Maximum number of inactive turns allowed, where a bot does not take any action before it is zapped by the game.int
getNumberOfRounds()
Returns the number of rounds in a battle.int
getReadyTimeout()
Returns the time limit in milliseconds for sending ready message after having received 'new battle' message.int
getTurnTimeout()
Returns the timeout in milliseconds for sending intent after having received 'tick' message.
-
-
-
Method Detail
-
getGameType
public java.lang.String getGameType()
Returns the game type, e.g. "melee".- Returns:
- The game type.
-
getArenaWidth
public int getArenaWidth()
Returns the width of the arena measured in units.- Returns:
- The width of the arena measured in units.
-
getArenaHeight
public int getArenaHeight()
Returns the height of the arena measured in units.- Returns:
- The height of the arena measured in units.
-
getNumberOfRounds
public int getNumberOfRounds()
Returns the number of rounds in a battle.- Returns:
- The number of rounds in a battle.
-
getGunCoolingRate
public double getGunCoolingRate()
Returns the gun cooling rate. The gun needs to cool down to a gun heat of zero before the gun is able to fire.- Returns:
- The gun cooling rate.
-
getMaxInactivityTurns
public int getMaxInactivityTurns()
Returns the Maximum number of inactive turns allowed, where a bot does not take any action before it is zapped by the game.- Returns:
- The Maximum number of inactive turns allowed.
-
getTurnTimeout
public int getTurnTimeout()
Returns the timeout in milliseconds for sending intent after having received 'tick' message.- Returns:
- The turn timeout in milliseconds.
-
getReadyTimeout
public int getReadyTimeout()
Returns the time limit in milliseconds for sending ready message after having received 'new battle' message.- Returns:
- The ready timeout in milliseconds.
-
-