BWAPI  4.1.2
An API for interacting with Starcraft: Broodwar (1.16.1)
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules
Public Member Functions | List of all members
BWAPI::Playerset Class Reference
Inheritance diagram for BWAPI::Playerset:
Inheritance graph

Public Member Functions

Race::set getRaces () const
 
Unitset getUnits () const
 
void setAlliance (bool allies=true, bool alliedVictory=true)
 
- Public Member Functions inherited from std::unordered_set< K >
unordered_set (T...args)
 
begin (T...args)
 
begin(int) (T...args)
 
bucket (T...args)
 
bucket_count (T...args)
 
bucket_size (T...args)
 
cbegin (T...args)
 
cbegin(int) (T...args)
 
cend (T...args)
 
cend(int) (T...args)
 
clear (T...args)
 
count (T...args)
 
emplace (T...args)
 
emplace_hint (T...args)
 
empty (T...args)
 
end (T...args)
 
end(int) (T...args)
 
equal_range (T...args)
 
erase (T...args)
 
find (T...args)
 
get_allocator (T...args)
 
hash_function (T...args)
 
insert (T...args)
 
key_eq (T...args)
 
load_factor (T...args)
 
max_bucket_count (T...args)
 
max_load_factor (T...args)
 
max_size (T...args)
 
operator= (T...args)
 
rehash (T...args)
 
reserve (T...args)
 
size (T...args)
 
swap (T...args)
 

Additional Inherited Members

- Public Attributes inherited from std::unordered_set< K >
keys
 

Detailed Description

A set containing Player objects.

Member Function Documentation

Unitset BWAPI::Playerset::getUnits ( ) const

Returns the set of all units that every player in this set owns.

Returns
Unitset containing Playerset's units
See also
PlayerInterface::getUnits
Race::set BWAPI::Playerset::getRaces ( ) const

Returns the list of races that each player in the set is.

Returns
Race::set containing Playerset's races
See also
PlayerInterface::getRace
void BWAPI::Playerset::setAlliance ( bool  allies = true,
bool  alliedVictory = true 
)

Sets the alliance status with all players contained in the Playerset.

Parameters
alliesSet to true to set the player to allied, or false for enemy.
alliedVictorySet to true to turn on allied victory, or false to disable it.
See also
Game::setAlliance