Package com.github.ocraft.s2client.bot.gateway

Interface ControlInterface

public interface ControlInterface

Method Summary

Modifier and Type	Method	Description
AgentControlInterface	agentControl()
void	clearClientErrors()
void	clearProtocolErrors()
boolean	connect(ProcessSettings processSettings)
boolean	createGame(BattlenetMap battlenetMap, java.util.List<PlayerSettings> playerSettings, java.lang.Boolean realtime)
boolean	createGame(LocalMap localMap, java.util.List<PlayerSettings> playerSettings, java.lang.Boolean realtime)
DebugInterface	debug()
void	dumpProtoUsage()
void	error(ClientError error, java.util.List<java.lang.String> errors)
void	errorIf(boolean condition, ClientError error, java.util.List<java.lang.String> errors)
AppState	getAppState()
java.util.List<ClientError>	getClientErrors()
GameStatus	getLastStatus()
boolean	getObservation()
ProcessInfo	getProcessInfo()
java.util.List<java.lang.String>	getProtocolErrors()
io.reactivex.Maybe<Response>	getResponsePending(ResponseType type)
boolean	hasResponsePending()
boolean	hasResponsePending(ResponseType type)
boolean	isFinishedGame()
boolean	isInGame()
boolean	isMultiplayer()
boolean	isReadyForCreateGame()
boolean	issueEvents(java.util.List<Tag> commands)
boolean	load()
ObservationInterface	observation()
ObserverActionInterface	observerAction()
void	onGameStart()
boolean	ping()
boolean	pollLeaveGame()
boolean	pollLeaveGame(io.reactivex.Maybe<Response> waitFor)
boolean	pollResponse(ResponseType type)
ProtoInterface	proto()
QueryInterface	query()
void	quit()
boolean	remoteSaveMap(LocalMap localMap)
ReplayControlInterface	replayControl(S2ReplayObserver replayObserver)
io.reactivex.Maybe<Response>	requestJoinGame(PlayerSettings playerSettings, InterfaceSettings interfaceSettings, MultiplayerOptions multiplayerOptions)
io.reactivex.Maybe<Response>	requestLeaveGame()
boolean	save()
boolean	saveReplay(java.nio.file.Path path)
void	setProcessInfo(ProcessInfo pi)
io.reactivex.Maybe<Response>	step(int count)
void	useGeneralizedAbility(boolean useGeneralizedAbilityId)
java.util.Optional<Response>	waitForResponse(io.reactivex.Maybe<Response> waitFor)
boolean	waitJoinGame(io.reactivex.Maybe<Response> waitFor)
boolean	waitStep(io.reactivex.Maybe<Response> waitFor)

Method Detail

proto

ProtoInterface proto()

observation

ObservationInterface observation()

connect

boolean connect(ProcessSettings processSettings)

remoteSaveMap

boolean remoteSaveMap(LocalMap localMap)

createGame

boolean createGame(BattlenetMap battlenetMap,
                   java.util.List<PlayerSettings> playerSettings,
                   java.lang.Boolean realtime)

createGame

boolean createGame(LocalMap localMap,
                   java.util.List<PlayerSettings> playerSettings,
                   java.lang.Boolean realtime)

requestJoinGame

io.reactivex.Maybe<Response> requestJoinGame(PlayerSettings playerSettings,
                                             InterfaceSettings interfaceSettings,
                                             MultiplayerOptions multiplayerOptions)

isMultiplayer

boolean isMultiplayer()

waitJoinGame

boolean waitJoinGame(io.reactivex.Maybe<Response> waitFor)

requestLeaveGame

io.reactivex.Maybe<Response> requestLeaveGame()

pollLeaveGame

boolean pollLeaveGame(io.reactivex.Maybe<Response> waitFor)

pollLeaveGame

boolean pollLeaveGame()

step

io.reactivex.Maybe<Response> step(int count)

waitStep

boolean waitStep(io.reactivex.Maybe<Response> waitFor)

saveReplay

boolean saveReplay(java.nio.file.Path path)
            throws java.io.IOException

Throws:

java.io.IOException

ping

boolean ping()

quit

void quit()

waitForResponse

java.util.Optional<Response> waitForResponse(io.reactivex.Maybe<Response> waitFor)

setProcessInfo

void setProcessInfo(ProcessInfo pi)

getProcessInfo

ProcessInfo getProcessInfo()

getAppState

AppState getAppState()

getLastStatus

GameStatus getLastStatus()

isInGame

boolean isInGame()

isFinishedGame

boolean isFinishedGame()

isReadyForCreateGame

boolean isReadyForCreateGame()

pollResponse

boolean pollResponse(ResponseType type)

hasResponsePending

boolean hasResponsePending(ResponseType type)

hasResponsePending

boolean hasResponsePending()

getResponsePending

io.reactivex.Maybe<Response> getResponsePending(ResponseType type)

getObservation

boolean getObservation()

issueEvents

boolean issueEvents(java.util.List<Tag> commands)

onGameStart

void onGameStart()

dumpProtoUsage

void dumpProtoUsage()

error

void error(ClientError error,
           java.util.List<java.lang.String> errors)

errorIf

void errorIf(boolean condition,
             ClientError error,
             java.util.List<java.lang.String> errors)

getClientErrors

java.util.List<ClientError> getClientErrors()

getProtocolErrors

java.util.List<java.lang.String> getProtocolErrors()

clearClientErrors

void clearClientErrors()

clearProtocolErrors

void clearProtocolErrors()

useGeneralizedAbility

void useGeneralizedAbility(boolean useGeneralizedAbilityId)

save

boolean save()

load

boolean load()

agentControl

AgentControlInterface agentControl()

query

QueryInterface query()

debug

DebugInterface debug()

observerAction

ObserverActionInterface observerAction()

replayControl

ReplayControlInterface replayControl(S2ReplayObserver replayObserver)