BWAPI::Force Class Reference

#include <Force.h>

Inheritance diagram for BWAPI::Force:

List of all members.

Public Member Functions
virtual int	getID () const =0
virtual std::string	getName () const =0
virtual std::set< Player * >	getPlayers () const =0
Protected Member Functions
virtual	~Force ()

---

Detailed Description

The Force class is used to get information about each force in the match, such as the name of the force and the set of players in the force.

---

Constructor & Destructor Documentation

virtual BWAPI::Force::~Force

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual int BWAPI::Force::getID

(

)

const [pure virtual]

Returns a unique ID for the force.

Implemented in BWAPI::ForceImpl, and BWAPI::ForceImpl.

virtual std::string BWAPI::Force::getName

(

)

const [pure virtual]

Returns the name of the force.

Implemented in BWAPI::ForceImpl, and BWAPI::ForceImpl.

virtual std::set<Player*> BWAPI::Force::getPlayers

(

)

const [pure virtual]

Returns the set of players in the force.

Implemented in BWAPI::ForceImpl, and BWAPI::ForceImpl.

---

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

• trunk/bwapi/include/BWAPI/Force.h