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

Public Member Functions

constexpr GameType (int id=GameTypes::Enum::None)

Detailed Description

A class that represents game types in Broodwar.

A game type is selected when creating a game.

See also
GameTypes

Constructor & Destructor Documentation

constexpr BWAPI::GameType::GameType (int id = GameTypes::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.

Parameters
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::GameTypes::allGameTypes().