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

Interface ObservationInterface

public interface ObservationInterface

The ObservationInterface reflects the current state of the game. Guaranteed to be valid when OnGameStart or OnStep is called.

Method Summary

Modifier and Type	Method	Description
java.util.Map<Ability,AbilityData>	getAbilityData(boolean forceRefresh)	Gets metadata of abilities.
int	getArmyCount()	The number of army units.
java.util.Map<Buff,BuffData>	getBuffData(boolean forceRefresh)	Gets metadata of buffs.
Point	getCameraPos()	Position of the center of the camera.
java.util.List<ChatReceived>	getChatMessages()	Gets new chat messages.
java.util.Map<Effect,EffectData>	getEffectData(boolean forceRefresh)	Gets metadata of effects.
java.util.List<EffectLocations>	getEffects()	Gets all active effects in vision of the current player.
java.util.List<ActionSpatial>	getFeatureLayerActions()	Gets a list of actions performed.
int	getFoodArmy()	The total supply consumed by army units alone.
int	getFoodCap()	The total supply cap given the players max possible supply.
int	getFoodUsed()	The total supply used by the player as defined: getFoodArmy() + getFoodWorkers().
int	getFoodWorkers()	The total supply consumed by workers units alone.
ResponseGameInfo	getGameInfo()	Gets the GameInfo struct for the current map.
long	getGameLoop()	Get the current game loop for this observation.
int	getIdleWorkerCount()	The number of workers that currently have no orders.
int	getMinerals()	The mineral count of the player.
int	getPlayerId()	Gets a unique ID that represents the player.
java.util.List<PowerSource>	getPowerSources()	Gets all power sources associated with the current player.
java.util.List<ActionRaw>	getRawActions()	Gets a list of actions performed as abilities applied to units.
Observation	getRawObservation()	A pointer to the low-level protocol data for the current observation.
java.util.List<ActionSpatial>	getRenderedActions()	Gets a list of actions performed.
java.util.List<PlayerResult>	getResults()	Gets the results of the game.
Score	getScore()	Gets the detailed current set of scores.
Point	getStartLocation()	Gets the initial start location of the player.
UnitInPool	getUnit(Tag tag)	Get the unit state as represented by the last call to getObservation.
java.util.List<UnitInPool>	getUnits()	Get a list of all known units in the game.
java.util.List<UnitInPool>	getUnits(Alliance alliance)
java.util.List<UnitInPool>	getUnits(Alliance alliance, java.util.function.Predicate<UnitInPool> filter)	Get all units belonging to a certain alliance and meet the conditions provided by the filter.
java.util.List<UnitInPool>	getUnits(java.util.function.Predicate<UnitInPool> filter)	Get all units belonging to self that meet the conditions provided by the filter.
java.util.Map<UnitType,UnitTypeData>	getUnitTypeData(boolean forceRefresh)	Gets metadata of units.
java.util.Map<Upgrade,UpgradeData>	getUpgradeData(boolean forceRefresh)	Gets metadata of upgrades.
java.util.List<Upgrade>	getUpgrades()	Gets all upgrades.
int	getVespene()	The vespene count of the player.
Visibility	getVisibility(Point2d point)	Returns visibility value of the given point for the current player.
int	getWarpGateCount()	Number of warp gates owned by the player.
boolean	hasCreep(Point2d point)	Returns 'true' if the given point has creep.
boolean	isPathable(Point2d point)	Returns 'true' if the given point on the terrain is pathable.
boolean	isPlacable(Point2d point)	Returns 'true' if the given point on the terrain is buildable.
float	terrainHeight(Point2d point)	Returns terrain height of the given point.

Method Detail

getPlayerId

int getPlayerId()

Gets a unique ID that represents the player.

Returns:

The player ID.

getGameLoop

long getGameLoop()

Get the current game loop for this observation.

Returns:

The game loop.

getUnits

java.util.List<UnitInPool> getUnits()

Get a list of all known units in the game.

Returns:

List of all ally and visible enemy and neutral units.

getUnits

java.util.List<UnitInPool> getUnits(Alliance alliance,
                                    java.util.function.Predicate<UnitInPool> filter)

Get all units belonging to a certain alliance and meet the conditions provided by the filter. The unit structure is data only. Therefore editing that data will not change any in game state. See the ActionInterface for changing Unit state.

Parameters:

alliance - The faction the units belong to.

filter - A functor or lambda used to filter out any unneeded units in the list.

Returns:

A list of units that meet the conditions provided by alliance and filter.

getUnits

java.util.List<UnitInPool> getUnits(Alliance alliance)

See Also:

getUnits(Alliance, Predicate)

getUnits

java.util.List<UnitInPool> getUnits(java.util.function.Predicate<UnitInPool> filter)

Get all units belonging to self that meet the conditions provided by the filter. The unit structure is data only. Therefore editing that data will not change any in game state. See the ActionInterface for changing Unit state.

Parameters:

filter - A functor or lambda used to filter out any unneeded units in the list.

Returns:

A list of units that meet the conditions provided by the filter.

getUnit

UnitInPool getUnit(Tag tag)

Get the unit state as represented by the last call to getObservation.

Parameters:

tag - Unique tag of the unit.

Returns:

Pointer to the Unit object.

getRawActions

java.util.List<ActionRaw> getRawActions()

Gets a list of actions performed as abilities applied to units. For use with the raw option.

Returns:

List of raw actions.

getFeatureLayerActions

java.util.List<ActionSpatial> getFeatureLayerActions()

Gets a list of actions performed. For use with the feature layer options.

Returns:

List of actions.

getRenderedActions

java.util.List<ActionSpatial> getRenderedActions()

Gets a list of actions performed. For use with the rendered options.

Returns:

List of actions.

getChatMessages

java.util.List<ChatReceived> getChatMessages()

Gets new chat messages.

Returns:

List of chat messages.

getPowerSources

java.util.List<PowerSource> getPowerSources()

Gets all power sources associated with the current player.

Returns:

List of power sources.

getEffects

java.util.List<EffectLocations> getEffects()

Gets all active effects in vision of the current player.

Returns:

List of effects.

getUpgrades

java.util.List<Upgrade> getUpgrades()

Gets all upgrades.

Returns:

List of upgrades.

getScore

Score getScore()

Gets the detailed current set of scores.

Returns:

The current score structure.

getAbilityData

java.util.Map<Ability,AbilityData> getAbilityData(boolean forceRefresh)

Gets metadata of abilities. Array can be indexed directly by AbilityID.

Parameters:

forceRefresh - forces a full query from the game, may otherwise cache data from a previous call.

Returns:

Data about all abilities possible for the current game session.

getUnitTypeData

java.util.Map<UnitType,UnitTypeData> getUnitTypeData(boolean forceRefresh)

Gets metadata of units. Array can be indexed directly by UnitID.

Parameters:

forceRefresh - forces a full query from the game, may otherwise cache data from a previous call.

Returns:

Data about all units possible for the current game session.

getUpgradeData

java.util.Map<Upgrade,UpgradeData> getUpgradeData(boolean forceRefresh)

Gets metadata of upgrades. Array can be indexed directly by UpgradeID.

Parameters:

forceRefresh - forces a full query from the game, may otherwise cache data from a previous call.

Returns:

Data about all upgrades possible for the current game session.

getBuffData

java.util.Map<Buff,BuffData> getBuffData(boolean forceRefresh)

Gets metadata of buffs. Array can be indexed directly by BuffID.

Parameters:

forceRefresh - forces a full query from the game, may otherwise cache data from a previous call.

Returns:

Data about all buffs possible for the current game session.

getEffectData

java.util.Map<Effect,EffectData> getEffectData(boolean forceRefresh)

Gets metadata of effects. Array can be indexed directly by EffectID.

Parameters:

forceRefresh - forces a full query from the game, may otherwise cache data from a previous call.

Returns:

Data about all effects possible for the current game session.

getGameInfo

ResponseGameInfo getGameInfo()

Gets the GameInfo struct for the current map.

Returns:

The current GameInfo struct.

getMinerals

int getMinerals()

The mineral count of the player.

Returns:

The mineral count.

getVespene

int getVespene()

The vespene count of the player.

Returns:

The vespene count.

getFoodCap

int getFoodCap()

The total supply cap given the players max possible supply.

Returns:

Food cap.

See Also:

getFoodUsed(), getFoodArmy(), getFoodWorkers()

getFoodUsed

int getFoodUsed()

The total supply used by the player as defined: getFoodArmy() + getFoodWorkers().

Returns:

Food used.

See Also:

getFoodArmy(), getFoodWorkers()

getFoodArmy

int getFoodArmy()

The total supply consumed by army units alone.

Returns:

Food used by army units.

See Also:

getFoodUsed(), getFoodWorkers()

getFoodWorkers

int getFoodWorkers()

The total supply consumed by workers units alone.

Returns:

Food used by worker units.

See Also:

getFoodArmy(), getFoodUsed()

getIdleWorkerCount

int getIdleWorkerCount()

The number of workers that currently have no orders.

Returns:

Count of idle workers.

getArmyCount

int getArmyCount()

The number of army units.

Returns:

Count of army units.

getWarpGateCount

int getWarpGateCount()

Number of warp gates owned by the player. This value should only be nonzero for Protoss.

Returns:

Count of warp gates.

getCameraPos

Point getCameraPos()

Position of the center of the camera.

Returns:

Camera position.

getStartLocation

Point getStartLocation()

Gets the initial start location of the player.

Returns:

Player start position.

getResults

java.util.List<PlayerResult> getResults()

Gets the results of the game.

Returns:

Player results if the game ended, an empty vector otherwise.

hasCreep

boolean hasCreep(Point2d point)

Returns 'true' if the given point has creep.

Parameters:

point - Position to sample.

Returns:

Creep.

getVisibility

Visibility getVisibility(Point2d point)

Returns visibility value of the given point for the current player.

Parameters:

point - Position to sample.

Returns:

Visibility.

isPathable

boolean isPathable(Point2d point)

Returns 'true' if the given point on the terrain is pathable. This does not include pathing blockers like structures. For more accurate pathing results use QueryInterface::PathingDistance.

Parameters:

point - Position to sample.

Returns:

Pathable.

isPlacable

boolean isPlacable(Point2d point)

Returns 'true' if the given point on the terrain is buildable. This does not include blockers like other structures. For more accurate building placement results use QueryInterface#placement.

Parameters:

point - Position to sample.

Returns:

Placable.

terrainHeight

float terrainHeight(Point2d point)

Returns terrain height of the given point.

Parameters:

point - Position to sample.

Returns:

Height.

getRawObservation

Observation getRawObservation()

A pointer to the low-level protocol data for the current observation. While it's possible to extract most in-game data from this pointer it is highly discouraged. It should only be used for extracting feature layers because it would be inefficient to copy these each frame.

Returns:

A pointer to the Observation.

See Also:

ControlInterface.getObservation()