PlayerType

class BWAPI.PlayerType

Represents the type of controller for the player slot (i.e. human, computer).

See also

BWAPI.PlayerTypes

Constructors

PlayerType([id = PlayerTypes.Enum.None])

Expected type constructor.

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

Parameters:id (int) – The 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 Unknown.

Member Functions

getID() → int

Retrieves this type’s identifier as an integer.

Returns:An integer representation of this type. Return type:int

isValid() → boolean

Checks if the current type has a valid identifier. The purpose of this function is to prevent buffer overflows if a type has been handled improperly.

A type is valid if it is between 0 and Unknown (inclusive).

Returns:true if this type is valid and false otherwise. Return type:boolean

getName() → string

Returns:The variable name of the type. Return type:string

isGameType() → boolean

Identifies whether or not this type is used in-game.

A type such as PlayerTypes.Closed would not be a valid in-game type.

Returns:true if the type can appear in-game, false otherwise. Return type:boolean

See also

isLobbyType()

isLobbyType() → boolean

Identifies whether or not this type is used for the pre-game lobby.

A type such as PlayerTypes.ComputerLeft would only appear in-game when a computer player is defeated.

Returns:true if this type can appear in the pre-game lobby, false otherwise. Return type:boolean

PlayerTypeset

class BWAPI.PlayerTypeset

A container for a set of PlayerType objects.

Constructors

PlayerTypeset()

Default constructor.

PlayerTypeset(set)

Copy constructor.

Parameters:set (BWAPI.PlayerTypeset) – The PlayerTypeset to copy.

PlayerTypeset(tbl)

Constructor to convert a Lua table to a set. Any values in the table that are of type PlayerType are added to the set.

Parameters:tbl (table) – A table containing PlayerType objects.

Member Functions

iterator() → iteratorFunction

Returns an iterator function intended to be used in for loops (e.g. for item in set:iterator() do).

Returns:An iterator function that will return the next value in the set with each successive call. Return type:function

asTable() → table

Returns the values of the set as an array-like Lua table.

Note

The ordering of the returned table is arbitrary (due to sets being unordered in the C++ implementation).

Returns:An array-like Lua table containing each value in the set. Return type:table

count(val) → int

Searches the set for elements with a value of val and returns the number of elements found. Because sets do not allow for duplicate values, this means that the function will return either 1 or 0. Because of this, it’s recommended to use contains() instead.

See also

contains(), std::unordered_set::count

contains(val) → boolean

Checks if this set contains a specific value.

Returns:true if the set contains the specified value, or false otherwise. Return type:boolean

size() → int

Returns:The number of values in the set. Return type:int

Note

set:size() is exactly equivalent to #set

empty() → boolean

Returns:true if the set is empty (size() == 0), or false otherwise. Return type:boolean

insert(val)

Inserts the value into the set.

Note

Sets cannot contain duplicate values. If the value already exists in the set, the set will not be modified.

erase(val) → numElementsErased

Removes val from the set if it exists.

Returns:The number of elements removed. Because sets do not allow for duplicate values, this means that the function will return either 1 or 0. Return type:int

clear()

Removes all elements from the set, leaving it with a size of 0.

eraseIf(pred)

Iterates the set and erases each element x where pred(x) returns true. The set is modified in place.

Parameters:pred (function) – A predicate function that takes a value and returns true for values that should be erased and false otherwise.

erase_if(pred)

Alias of eraseIf()

filter(pred)

Iterates the set and erases each element x where pred(x) returns false. The set is modified in place.

Parameters:pred (function) – A predicate function that takes a value and returns true for values that should be kept and false for elements that should be erased.

keepIf(pred)

Alias of filter()/keep_if()

keep_if(pred)

Alias of filter()/keepIf()