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

Interface ActionInterface

public interface ActionInterface

The ActionInterface issues actions to units in a game. Not available in replays. Guaranteed to be valid when the OnStep event is called.

void unitCommand(Tag unitTag, Ability ability) - batches a unitCommand that will be dispatched when #sendActions() is called. unitCommand has many overloaded functions, you can call it with most combinations of Unit types (the Unit object or tag), ability types and targets (a 2d position or tag).

• unitTag: The unique id that represents the unit.
• ability: The unique id that represents the ability, see Abilities for ids.

See Also:

Abilities, Unit, Point2d, sendActions()

Method Summary

Modifier and Type	Method	Description
java.util.List<Tag>	commands()	Returns a list of unit tags that have sent commands out in the last call to SendActions.
boolean	sendActions()	This function sends out all batched unit commands.
ActionInterface	sendChat(java.lang.String message, ActionChat.Channel channel)	Sends a message to the game chat.
ActionInterface	toggleAutocast(Tag unitTag, Ability ability)	Enables or disables autocast of an ability on a unit.
ActionInterface	toggleAutocast(java.util.List<Tag> unitTags, Ability ability)	Enables or disables autocast of an ability on a list of units.
ActionInterface	unitCommand(Unit unit, Ability ability, boolean queuedCommand)	Issues a command to a unit.
ActionInterface	unitCommand(Unit unit, Ability ability, Point2d point, boolean queuedCommand)	Issues a command to a unit.
ActionInterface	unitCommand(Unit unit, Ability ability, Unit target, boolean queuedCommand)	Issues a command to a unit.
ActionInterface	unitCommand(java.util.List<Unit> units, Ability ability, boolean queuedMove)	Issues a command to multiple units (prefer this where possible).
ActionInterface	unitCommand(java.util.List<Unit> units, Ability ability, Point2d point, boolean queuedCommand)	Issues a command to multiple units (prefer this where possible).
ActionInterface	unitCommand(java.util.List<Unit> units, Ability ability, Unit target, boolean queuedCommand)	Issues a command to multiple units (prefer this where possible).

Method Detail

unitCommand

ActionInterface unitCommand(Unit unit,
                            Ability ability,
                            boolean queuedCommand)

Issues a command to a unit. Self targeting.

Parameters:

unit - The unit to send the command to.

ability - The ability id of the command.

unitCommand

ActionInterface unitCommand(Unit unit,
                            Ability ability,
                            Point2d point,
                            boolean queuedCommand)

Issues a command to a unit. Targets a point.

Parameters:

unit - The unit to send the command to.

ability - The ability id of the command.

point - The 2D world position to target.

unitCommand

ActionInterface unitCommand(Unit unit,
                            Ability ability,
                            Unit target,
                            boolean queuedCommand)

Issues a command to a unit. Targets another unit.

Parameters:

unit - The unit to send the command to.

ability - The ability id of the command.

target - The unit that is a target of the unit getting the command.

unitCommand

ActionInterface unitCommand(java.util.List<Unit> units,
                            Ability ability,
                            boolean queuedMove)

Issues a command to multiple units (prefer this where possible). Same as unitCommand(Unit, Ability).

unitCommand

ActionInterface unitCommand(java.util.List<Unit> units,
                            Ability ability,
                            Point2d point,
                            boolean queuedCommand)

Issues a command to multiple units (prefer this where possible). Same as unitCommand(Unit, Ability, Point2d).

unitCommand

ActionInterface unitCommand(java.util.List<Unit> units,
                            Ability ability,
                            Unit target,
                            boolean queuedCommand)

Issues a command to multiple units (prefer this where possible). Same as unitCommand(Unit, Ability, Unit).

commands

java.util.List<Tag> commands()

Returns a list of unit tags that have sent commands out in the last call to SendActions. This will be used to determine if a unit actually has a command when the observation is received.

Returns:

Array of units that have sent commands.

toggleAutocast

ActionInterface toggleAutocast(Tag unitTag,
                               Ability ability)

Enables or disables autocast of an ability on a unit.

Parameters:

unitTag - The unit to toggle the ability on.

ability - The ability to be toggled.

toggleAutocast

ActionInterface toggleAutocast(java.util.List<Tag> unitTags,
                               Ability ability)

Enables or disables autocast of an ability on a list of units.

Parameters:

unitTags - The units to toggle the ability on.

ability - The ability to be toggled.

sendChat

ActionInterface sendChat(java.lang.String message,
                         ActionChat.Channel channel)

Sends a message to the game chat.

Parameters:

message - Text of message to send.

channel - Which players will see the message.

sendActions

boolean sendActions()

This function sends out all batched 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. For example, if you wanted to move 20 marines to some position on the map you'd want to batch all of those unit commands and send them at once.