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

Interface QueryInterface

public interface QueryInterface

The QueryInterface provides additional data not contained in the observation.

Performance note: - Always try and batch things up. These queries are effectively synchronous and will block until returned.

Method Summary

Modifier and Type	Method	Description
default java.util.List<Point>	calculateExpansionLocations(ObservationInterface observation)
default java.util.List<Point>	calculateExpansionLocations(ObservationInterface observation, DebugInterface debug)
default java.util.List<Point>	calculateExpansionLocations(ObservationInterface observation, DebugInterface debug, ExpansionParameters parameters)	Calculates expansion locations, this call can take on the order of 100ms since it makes blocking queries to SC2 so call it once and cache the results.
static java.util.Map<Point,java.util.List<UnitInPool>>	cluster(java.util.List<UnitInPool> units, double distanceApart)	Clusters units within some distance of each other and returns a list of them and their center of mass.
AvailableAbilities	getAbilitiesForUnit(Unit unit, boolean ignoreResourceRequirements)	Returns a list of abilities represented as a AvailableAbilities see the Abilities enum for their corresponding, named, representations.
java.util.List<AvailableAbilities>	getAbilitiesForUnits(java.util.List<Unit> units, boolean ignoreResourceRequirements)	Issues multiple available abilities queries.
float	pathingDistance(Point2d start, Point2d end)	Returns pathing distance between two locations.
float	pathingDistance(Unit start, Point2d end)	Returns pathing distance between a unit and a target location.
java.util.List<java.lang.Float>	pathingDistance(java.util.List<QueryPathing> queries)	Issues multiple pathing queries.
boolean	placement(Ability ability, Point2d target)
boolean	placement(Ability ability, Point2d target, Unit unit)	Returns whether a building can be placed at a location.
java.util.List<java.lang.Boolean>	placement(java.util.List<QueryBuildingPlacement> queries)	A batch version of the above Placement query.

Method Detail

getAbilitiesForUnit

AvailableAbilities getAbilitiesForUnit(Unit unit,
                                       boolean ignoreResourceRequirements)

Returns a list of abilities represented as a AvailableAbilities see the Abilities enum for their corresponding, named, representations.

Parameters:

unit - Unit.

ignoreResourceRequirements - Ignores food, mineral and gas costs, as well as cooldowns.

Returns:

Abilities for the unit.

getAbilitiesForUnits

java.util.List<AvailableAbilities> getAbilitiesForUnits(java.util.List<Unit> units,
                                                        boolean ignoreResourceRequirements)

Issues multiple available abilities queries. Batch version.

Parameters:

units - Units.

ignoreResourceRequirements - Ignores food, mineral and gas costs, as well as cooldowns.

Returns:

Abilities for the units.

pathingDistance

float pathingDistance(Point2d start,
                      Point2d end)

Returns pathing distance between two locations. Takes into account unit movement properties (e.g. Flying).

Parameters:

start - Starting point.

end - End point.

Returns:

Distance between the two points.

pathingDistance

float pathingDistance(Unit start,
                      Point2d end)

Returns pathing distance between a unit and a target location. Takes into account unit movement properties (e.g. Flying). Batch version.

Parameters:

start - Starting points.

end - End points.

Returns:

Distances between the two points.

pathingDistance

java.util.List<java.lang.Float> pathingDistance(java.util.List<QueryPathing> queries)

Issues multiple pathing queries.

placement

boolean placement(Ability ability,
                  Point2d target)

See Also:

placement(Ability, Point2d, Unit)

placement

boolean placement(Ability ability,
                  Point2d target,
                  Unit unit)

Returns whether a building can be placed at a location. The placing unit field is optional. This is only used for cases where the placing unit plays a role in the placement grid test (e.g. A flying barracks building an add-on requires room for both the barracks and add-on).

Parameters:

ability - Ability for building or moving a structure.

target - Position to attempt placement on.

unit - (Optional) The unit that is moving, if moving a structure.

Returns:

If placement is possible.

placement

java.util.List<java.lang.Boolean> placement(java.util.List<QueryBuildingPlacement> queries)

A batch version of the above Placement query. Takes an array of abilities, positions and optional unit tags and returns a matching array of booleans indicating if placement is possible.

Parameters:

queries - Placement queries.

Returns:

Array of booleans indicating if placement is possible.

calculateExpansionLocations

default java.util.List<Point> calculateExpansionLocations(ObservationInterface observation,
                                                          DebugInterface debug,
                                                          ExpansionParameters parameters)

Calculates expansion locations, this call can take on the order of 100ms since it makes blocking queries to SC2 so call it once and cache the results.

Parameters:

debug - If filled out CalculateExpansionLocations will render spheres to show what it calculated.

calculateExpansionLocations

default java.util.List<Point> calculateExpansionLocations(ObservationInterface observation)

calculateExpansionLocations

default java.util.List<Point> calculateExpansionLocations(ObservationInterface observation,
                                                          DebugInterface debug)

cluster

static java.util.Map<Point,java.util.List<UnitInPool>> cluster(java.util.List<UnitInPool> units,
                                                               double distanceApart)

Clusters units within some distance of each other and returns a list of them and their center of mass.