bwapi

Class BWClient

java.lang.Object

bwapi.BWClient

public class BWClient
extends Object

Client class to connect to the game with.

Constructor Summary

Constructors

Constructor and Description
BWClient(BWEventListener eventListener)

Method Summary

Modifier and Type	Method and Description
int	framesBehind()
BWClientConfiguration	getConfiguration()
Game	getGame() Get the Game instance of the currently running game.
PerformanceMetrics	getPerformanceMetrics()
void	startGame() Start the game with default settings.
void	startGame(boolean autoContinue) Deprecated.
void	startGame(BWClientConfiguration gameConfiguration) Start the game.

Methods inherited from class java.lang.Object

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

Constructor Detail

BWClient

public BWClient(BWEventListener eventListener)

Method Detail

getGame

public Game getGame()

Get the Game instance of the currently running game. When running in asynchronous mode, this is the game from the bot's perspective, eg. potentially a previous frame.

getPerformanceMetrics

public PerformanceMetrics getPerformanceMetrics()

Returns:

JBWAPI performance metrics.

getConfiguration

public BWClientConfiguration getConfiguration()

Returns:

The current configuration

framesBehind

public int framesBehind()

Returns:

The number of frames between the one exposed to the bot and the most recent received by JBWAPI. This tracks the size of the frame buffer except when the game is paused (which results in multiple frames arriving with the same count).

startGame

public void startGame()

Start the game with default settings.

startGame

@Deprecated
public void startGame(boolean autoContinue)

Deprecated.

Start the game.

Parameters:

autoContinue - automatically continue playing the next game(s). false by default

startGame

public void startGame(BWClientConfiguration gameConfiguration)

Start the game.

Parameters:

gameConfiguration - Settings for playing games with this client.