BWAPI
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
BWAPI::Order Class Reference

#include <Order.h>

List of all members.

Public Member Functions

 Order ()
 Order (int id)
 Order (const Order &other)
Orderoperator= (const Order &other)
 operator int () const
int getID () const
std::string getName () const

Private Attributes

int id

Detailed Description

To get detailed information about what a unit is doing, you can use the Unit::getOrder method, which will return an Order object. Note that a single command, like gather minerals, can consist of several orders ( MoveToMinerals, HarvestMinerals2, MiningMinerals, ReturnMinerals, etc) which will indicate what state the unit is in while executing the command. For information about how to issue commands to units, go to Unit.

Definition at line 11 of file Order.h.


Constructor & Destructor Documentation

BWAPI::Order::Order ( int  id)
BWAPI::Order::Order ( const Order other)

Member Function Documentation

int BWAPI::Order::getID ( ) const

Returns the unique ID for this order.

std::string BWAPI::Order::getName ( ) const

Returns the name of this order.

BWAPI::Order::operator int ( ) const
Order& BWAPI::Order::operator= ( const Order other)

Member Data Documentation

int BWAPI::Order::id [private]

Definition at line 26 of file Order.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines