S2Coordinator (com.github.ocraft:ocraft-s2client 0.2.6-SNAPSHOT API)

java.lang.Object
- com.github.ocraft.s2client.bot.S2Coordinator

```
public class S2Coordinator
extends java.lang.Object
```
Coordinator of one or more clients. Used to start, step and stop games and replays.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`allGamesEnded()`	Returns true if all running games have ended.
`static PlayerSettings`	`createComputer(Race race, Difficulty difficulty)`
`S2Coordinator`	`createGame()`	Creates a game but does not join the bots to the game
`S2Coordinator`	`createGame(BattlenetMap battlenetMap)`	Creates a game but does not join the bots to the game
`S2Coordinator`	`createGame(LocalMap localMap)`	Creates a game but does not join the bots to the game
`static PlayerSettings`	`createParticipant(Race race, S2Agent bot)`
`boolean`	`equals(java.lang.Object o)`
`java.nio.file.Path`	`getExePath()`	Gets the game executable path.
`int`	`hashCode()`
`boolean`	`hasReplays()`	Determines if there are unprocessed replays.
`S2Coordinator`	`joinGame()`	Joins agents to the game
`void`	`leaveGame()`	Requests for the currently running game to end.
`void`	`quit()`
`boolean`	`remoteSaveMap(byte[] data, java.nio.file.Path path)`	Saves a binary blob as a map to a remote location.
`S2Coordinator`	`saveReplayList(java.nio.file.Path path)`	Saves replays to a file.
`static SettingsSyntax`	`setup()`
`void`	`setupPorts(int numberOfAgents, java.util.function.Supplier<java.lang.Integer> portStart, boolean checkSingle)`	Sets up the sc2 game ports to use
`S2Coordinator`	`startGame()`	Starts a game on a certain map.
`S2Coordinator`	`startGame(BattlenetMap battlenetMap)`	Starts a game on a certain map.
`S2Coordinator`	`startGame(LocalMap localMap)`	Starts a game on a certain map.
`java.lang.String`	`toString()`
`boolean`	`update()`	Helper function used to actually run a bot.

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

- Method Detail
  - setupPorts
```
public void setupPorts(int numberOfAgents,
                       java.util.function.Supplier<java.lang.Integer> portStart,
                       boolean checkSingle)
```
    Sets up the sc2 game ports to use
    
    Parameters:
    
    numberOfAgents - Number of agents in the game
    
    portStart - Starting port number
    
    checkSingle - Checks if the game is a single player or multiplayer game
  - setup
```
public static SettingsSyntax setup()
```
  - startGame
```
public S2Coordinator startGame()
```
    Starts a game on a certain map. There are multiple ways to specify a map: Absolute path: Any .SC2Map file. Relative path: Any .SC2Map file relative to either the library or installation maps folder. Map name: Any BattleNet published map that has been locally cached.
    
    See Also:
    
    startGame(BattlenetMap), startGame(LocalMap)
  - startGame
```
public S2Coordinator startGame(LocalMap localMap)
```
    Starts a game on a certain map. There are multiple ways to specify a map: Absolute path: Any .SC2Map file. Relative path: Any .SC2Map file relative to either the library or installation maps folder. Map name: Any BattleNet published map that has been locally cached.
    
    Parameters:
    
    localMap - Path to the map to run.
    
    See Also:
    
    startGame(BattlenetMap), startGame()
  - startGame
```
public S2Coordinator startGame(BattlenetMap battlenetMap)
```
    Starts a game on a certain map. There are multiple ways to specify a map: Absolute path: Any .SC2Map file. Relative path: Any .SC2Map file relative to either the library or installation maps folder. Map name: Any BattleNet published map that has been locally cached.
    
    Parameters:
    
    battlenetMap - Name of the battlenet map to run.
    
    See Also:
    
    startGame(LocalMap), startGame()
  - createGame
```
public S2Coordinator createGame()
```
    Creates a game but does not join the bots to the game
    
    See Also:
    
    createGame(BattlenetMap), createGame(LocalMap)
  - createGame
```
public S2Coordinator createGame(LocalMap localMap)
```
    Creates a game but does not join the bots to the game
    
    Parameters:
    
    localMap - Path to the map to run.
    
    See Also:
    
    createGame(BattlenetMap), createGame()
  - createGame
```
public S2Coordinator createGame(BattlenetMap battlenetMap)
```
    Creates a game but does not join the bots to the game
    
    Parameters:
    
    battlenetMap - Name of the battlenet map to run.
    
    See Also:
    
    createGame(LocalMap), createGame()
  - joinGame
```
public S2Coordinator joinGame()
```
    Joins agents to the game
  - update
```
public boolean update()
```
    Helper function used to actually run a bot. This function will behave differently in real-time compared to non real-time. In real-time there is no step sent over the wire but instead will request and read observations as the game runs.
    For non-real time Update will perform the following:
    1. Step the simulation forward by a certain amount of game steps, this essentially moves the game loops forward.
    2. Wait for the step to complete, the step is completed when a response is received and read from the StarCraft II binary. When the step is completed an Observation has been received. It is parsed and various client events are dispatched.
    3. Call the user's onStep function.
    Real time applications will perform the following:
    1. The Observation is directly requested. The process will block while waiting for it.
    2. The Observation is parsed and client events are dispatched.
    3. Unit actions batched from the ActionInterface are dispatched.
    Returns:
    
    False if the game has ended, true otherwise.
  - leaveGame
```
public void leaveGame()
```
    Requests for the currently running game to end.
  - allGamesEnded
```
public boolean allGamesEnded()
```
    Returns true if all running games have ended.
  - saveReplayList
```
public S2Coordinator saveReplayList(java.nio.file.Path path)
                             throws java.io.IOException
```
    Saves replays to a file.
    
    Parameters:
    
    path - The file path.
    
    Throws:
    
    java.io.IOException
  - hasReplays
```
public boolean hasReplays()
```
    Determines if there are unprocessed replays.
    
    Returns:
    
    Is true if there are replays left.
  - remoteSaveMap
```
public boolean remoteSaveMap(byte[] data,
                             java.nio.file.Path path)
```
    Saves a binary blob as a map to a remote location.
    
    Parameters:
    
    data - The map data.
    
    path - The file path to save the data to.
  - getExePath
```
public java.nio.file.Path getExePath()
```
    Gets the game executable path.
    
    Returns:
    
    The game executable path.
  - quit
```
public void quit()
```
  - createParticipant
```
public static PlayerSettings createParticipant(Race race,
                                               S2Agent bot)
```
  - createComputer
```
public static PlayerSettings createComputer(Race race,
                                            Difficulty difficulty)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class S2Coordinator

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setupPorts

setup

startGame

startGame

startGame

createGame

createGame

createGame

joinGame

update

leaveGame

allGamesEnded

saveReplayList

hasReplays

remoteSaveMap

getExePath

quit

createParticipant

createComputer

equals

hashCode

toString