Package com.github.ocraft.s2client.bot

Interface ClientEvents

All Known Implementing Classes:

S2Agent, S2ReplayObserver

public interface ClientEvents

Method Summary

Modifier and Type	Method	Description
default void	onBuildingConstructionComplete(UnitInPool unitInPool)	Called when the unit in the previous step had a build progress less than 1.0 but is greater than or equal to 1.0 in the current step.
default void	onError(java.util.List<ClientError> clientErrors, java.util.List<java.lang.String> protocolErrors)	Called for various errors the library can encounter.
default void	onGameEnd()	Called when a game has ended.
default void	onGameFullStart()	Called when a game is started after a load.
default void	onGameStart()	Called when a game is started or restarted.
default void	onNuclearLaunchDetected()	Called when a nuclear launch is detected.
default void	onNydusDetected()	Called when a nydus is placed.
default void	onStep()	In non realtime games this function gets called after each step as indicated by step size.
default void	onUnitCreated(UnitInPool unitInPool)	Called when a Unit has been created by the player.
default void	onUnitDestroyed(UnitInPool unitInPool)	Called whenever one of the player's units has been destroyed.
default void	onUnitEnterVision(UnitInPool unitInPool)	Called when an enemy unit enters vision from out of fog of war.
default void	onUnitIdle(UnitInPool unitInPool)	Called when a unit becomes idle, this will only occur as an event so will only be called when the unit becomes idle and not a second time.
default void	onUpgradeCompleted(Upgrade upgrade)	Called when an upgrade is finished, warp gate, ground weapons, baneling speed, etc.

Method Detail

onGameFullStart

default void onGameFullStart()

Called when a game is started after a load. Fast restarting will not call this.

onGameStart

default void onGameStart()

Called when a game is started or restarted.

onGameEnd

default void onGameEnd()

Called when a game has ended.

onStep

default void onStep()

In non realtime games this function gets called after each step as indicated by step size. In realtime this function gets called as often as possible after request/responses are received from the game gathering observation state.

onUnitDestroyed

default void onUnitDestroyed(UnitInPool unitInPool)

Called whenever one of the player's units has been destroyed.

Parameters:

unitInPool - The destroyed unit.

onUnitCreated

default void onUnitCreated(UnitInPool unitInPool)

Called when a Unit has been created by the player.

Parameters:

unitInPool - The created unit.

onUnitIdle

default void onUnitIdle(UnitInPool unitInPool)

Called when a unit becomes idle, this will only occur as an event so will only be called when the unit becomes idle and not a second time. Being idle is defined by having orders in the previous step and not currently having orders or if it did not exist in the previous step and now does, a unit being created, for instance, will call both onUnitCreated and onUnitIdle if it does not have a rally set.

Parameters:

unitInPool - The idle unit.

onUpgradeCompleted

default void onUpgradeCompleted(Upgrade upgrade)

Called when an upgrade is finished, warp gate, ground weapons, baneling speed, etc.

Parameters:

upgrade - The completed upgrade.

onBuildingConstructionComplete

default void onBuildingConstructionComplete(UnitInPool unitInPool)

Called when the unit in the previous step had a build progress less than 1.0 but is greater than or equal to 1.0 in the current step.

Parameters:

unitInPool - The constructed unit.

onNydusDetected

default void onNydusDetected()

Called when a nydus is placed.

onNuclearLaunchDetected

default void onNuclearLaunchDetected()

Called when a nuclear launch is detected.

onUnitEnterVision

default void onUnitEnterVision(UnitInPool unitInPool)

Called when an enemy unit enters vision from out of fog of war.

Parameters:

unitInPool - The unit entering vision.

onError

default void onError(java.util.List<ClientError> clientErrors,
                     java.util.List<java.lang.String> protocolErrors)

Called for various errors the library can encounter. See ClientError enum for possible errors.