Package com.github.ocraft.s2client.bot

Class S2Agent

java.lang.Object

com.github.ocraft.s2client.bot.S2Agent

All Implemented Interfaces:

ClientEvents

public abstract class S2Agent
extends java.lang.Object

The base class for user defined bots.

Constructor Summary

Constructors

Constructor	Description
S2Agent()

Method Summary

Modifier and Type	Method	Description
ActionInterface	actions()	Interface for issuing actions to units.
ActionFeatureLayerInterface	actionsFeatureLayer()	Interface for issuing actions in feature layers.
AgentControlInterface	agentControl()	The AgentControlInterface is only currently used for restarting a game.
ControlInterface	control()	The ControlInterface is only meant to be used by the coordinator as it provides functionality for connecting to Starcraft2, setting up a websocket connection and issuing blocking commands via SC2's protocol.
DebugInterface	debug()	The DebugInterface allows a derived class to print text, draw primitive shapes and spawn/destroy units.
ObservationInterface	observation()	The ObservationInterface is used to query game state.
QueryInterface	query()	The QueryInterface interface is used to issue commands to units.

Methods inherited from interface com.github.ocraft.s2client.bot.ClientEvents

onBuildingConstructionComplete, onError, onGameEnd, onGameFullStart, onGameStart, onNuclearLaunchDetected, onNydusDetected, onStep, onUnitCreated, onUnitDestroyed, onUnitEnterVision, onUnitIdle, onUpgradeCompleted

Methods inherited from class java.lang.Object

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

Constructor Detail

S2Agent

public S2Agent()

Method Detail

actions

public ActionInterface actions()

Interface for issuing actions to units. Actions should be batched via the UnitCommand functions then eventually dispatched with SendActions. If you are stepping the simulation yourself the Step will automatically call SendActions. If your bot is running in real time you must call SendActions yourself.

Returns:

The raw (basic) action interface.

actionsFeatureLayer

public ActionFeatureLayerInterface actionsFeatureLayer()

Interface for issuing actions in feature layers.

Returns:

The feature layer action interface.

agentControl

public AgentControlInterface agentControl()

The AgentControlInterface is only currently used for restarting a game. For internal use.

Returns:

The agent control interface.

observation

public ObservationInterface observation()

The ObservationInterface is used to query game state.

query

public QueryInterface query()

The QueryInterface interface is used to issue commands to units.

debug

public DebugInterface debug()

The DebugInterface allows a derived class to print text, draw primitive shapes and spawn/destroy units.

control

public ControlInterface control()

The ControlInterface is only meant to be used by the coordinator as it provides functionality for connecting to Starcraft2, setting up a websocket connection and issuing blocking commands via SC2's protocol.