SC2API
An API for AI for StarCraft II
Public Types | Public Member Functions | Public Attributes | List of all members
sc2::ActionRaw Struct Reference

An action (command or ability) applied to a unit or set of units. More...

#include <sc2_action.h>

Public Types

enum  TargetType { TargetNone, TargetUnitTag, TargetPosition }
 Type of target. Target types are mutually exclusive. More...
 

Public Member Functions

 ActionRaw ()
 Constructor.
 
bool operator== (const ActionRaw &a) const
 Comparison overload.
 

Public Attributes

AbilityID ability_id
 The ID of the ability to invoke.
 
std::vector< Tag > unit_tags
 Units this action applies to. In normal use, this would be the currently selected units.
 
TargetType target_type
 Which target fields are valid.
 
Tag target_tag
 The target of this action. Valid only when target_type == TargetUnitTag.
 
Point2D target_point
 The target point for this action. Valid only when target_type == TargetPosition.
 

Detailed Description

An action (command or ability) applied to a unit or set of units.

Member Enumeration Documentation

Type of target. Target types are mutually exclusive.

Enumerator
TargetNone 

No target generally means 'self', e.g., a order to make a unit.

TargetUnitTag 

The target is a unit tag, could also be a snapshot in the fog-of-war.

TargetPosition 

The target is a point.


The documentation for this struct was generated from the following file: