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

Interface ActionFeatureLayerInterface

public interface ActionFeatureLayerInterface

The ActionFeatureLayerInterface emulates UI actions in feature layer. Not available in replays. Guaranteed to be valid when the OnStep event is called.

Method Summary

Modifier and Type	Method	Description
ActionFeatureLayerInterface	cameraMove(PointI center)	Moves the camera to be centered around a position.
ActionFeatureLayerInterface	select(PointI center, ActionSpatialUnitSelectionPoint.Type selectionType)	Selection of a point, equivalent to clicking the mouse on a unit.
ActionFeatureLayerInterface	select(PointI p0, PointI p1, boolean addToSelection)	Selection of an area, equivalent to click-dragging the mouse over an area of the screen.
boolean	sendActions()	This function sends out all batched selection and unit commands.
ActionFeatureLayerInterface	unitCommand(Ability ability)	Issues a command to whatever is selected.
ActionFeatureLayerInterface	unitCommand(Ability ability, PointI point, boolean minimap)	Issues a command to whatever is selected.

Method Detail

unitCommand

ActionFeatureLayerInterface unitCommand(Ability ability)

Issues a command to whatever is selected. Self targeting.

Parameters:

ability - The ability id of the command.

unitCommand

ActionFeatureLayerInterface unitCommand(Ability ability,
                                        PointI point,
                                        boolean minimap)

Issues a command to whatever is selected. Uses a point as a target for the command.

Parameters:

ability - The ability id of the command.

point - The 2D world position to target.

minimap - Target in the minimap instead of the map.

cameraMove

ActionFeatureLayerInterface cameraMove(PointI center)

Moves the camera to be centered around a position. Coordinate is position on minimap feature layer.

select

ActionFeatureLayerInterface select(PointI center,
                                   ActionSpatialUnitSelectionPoint.Type selectionType)

Selection of a point, equivalent to clicking the mouse on a unit.

Parameters:

center - The feature layer 'pixel' being clicked on.

selectionType - Any modifier keys, for example if 'shift-click' is desired.

select

ActionFeatureLayerInterface select(PointI p0,
                                   PointI p1,
                                   boolean addToSelection)

Selection of an area, equivalent to click-dragging the mouse over an area of the screen.

Parameters:

p0 - The feature layer pixel where the first click occurs (mouse button down).

p1 - The feature layer pixel where the drag release occurs (mouse button up).

addToSelection - Will add newly selected units to an existing selection.

sendActions

boolean sendActions()

This function sends out all batched selection and unit commands. You DO NOT need to call this function in non real time simulations since it is automatically called when stepping the simulation forward. You only need to call this function in a real time simulation.