BWAPI  4.2.0
An API for interacting with Starcraft: Broodwar (1.16.1)
Public Member Functions | List of all members
BWAPI::UnitCommandType Class Reference
Inheritance diagram for BWAPI::UnitCommandType:
Inheritance graph

Public Member Functions

constexpr UnitCommandType (int id=UnitCommandTypes::Enum::None)

Detailed Description

A representation of a unit command in BWAPI.

This is used by bots to notify BWAPI which commands to use. BWAPI filters commands accordingly and then converts them to Broodwar commands, which differ in complexity.

See also

Constructor & Destructor Documentation

constexpr BWAPI::UnitCommandType::UnitCommandType (int id = UnitCommandTypes::Enum::None)

Expected type constructor.

If the type is an invalid type, then it becomes Types::Unknown. A type is invalid if its value is less than 0 or greater than Types::Unknown.

idThe id that corresponds to this type. It is typically an integer value that corresponds to an internal Broodwar type. If the given id is invalid, then it becomes Types::Unknown.

References BWAPI::UnitCommandTypes::allUnitCommandTypes().