UnitGroup Class Reference

#include <UnitGroup.h>

List of all members.

Public Member Functions
UnitGroup	operator+ (const UnitGroup &other) const
UnitGroup	operator* (const UnitGroup &other) const
UnitGroup	operator^ (const UnitGroup &other) const
UnitGroup	operator- (const UnitGroup &other) const
UnitGroup	inRadius (double radius, BWAPI::Position position) const
UnitGroup	inRegion (BWTA::Region *region) const
UnitGroup	onlyNearestChokepoint (BWTA::Chokepoint *choke) const
UnitGroup	onlyNearestBaseLocation (BWTA::BaseLocation *location) const
UnitGroup	onlyNearestUnwalkablePolygon (BWTA::Polygon *polygon) const
UnitGroup	operator() (int f1) const
UnitGroup	operator() (int f1, int f2) const
UnitGroup	operator() (int f1, int f2, int f3) const
UnitGroup	operator() (int f1, int f2, int f3, int f4) const
UnitGroup	operator() (int f1, int f2, int f3, int f4, int f5) const
UnitGroup	operator() (FliterAttributeScalar a, const char *compare, double value) const
UnitGroup	operator() (FliterAttributeScalar a, const char *compare, int value) const
UnitGroup	operator() (BWAPI::Player *player) const
UnitGroup	operator() (FilterAttributeUnit a, BWAPI::Unit *unit) const
UnitGroup	operator() (FilterAttributeType a, BWAPI::UnitType type) const
UnitGroup	operator() (FilterAttributeType a, BWAPI::TechType type) const
UnitGroup	operator() (FilterAttributeType a, BWAPI::UpgradeType type) const
UnitGroup	operator() (FilterAttributeOrder a, BWAPI::Order type) const
UnitGroup	operator() (FilterAttributePosition a, BWAPI::Position position) const
UnitGroup	operator() (FilterAttributeTilePosition a, BWAPI::TilePosition position) const
UnitGroup	not (int f1) const
UnitGroup	not (int f1, int f2) const
UnitGroup	not (int f1, int f2, int f3) const
UnitGroup	not (int f1, int f2, int f3, int f4) const
UnitGroup	not (int f1, int f2, int f3, int f4, int f5) const
UnitGroup	not (FliterAttributeScalar a, const char *compare, double value) const
UnitGroup	not (FliterAttributeScalar a, const char *compare, int value) const
UnitGroup	not (BWAPI::Player *player) const
UnitGroup	not (FilterAttributeUnit a, BWAPI::Unit *unit) const
UnitGroup	not (FilterAttributeType a, BWAPI::UnitType type) const
UnitGroup	not (FilterAttributeType a, BWAPI::TechType type) const
UnitGroup	not (FilterAttributeType a, BWAPI::UpgradeType type) const
UnitGroup	not (FilterAttributeOrder a, BWAPI::Order type) const
UnitGroup	not (FilterAttributePosition a, BWAPI::Position position) const
UnitGroup	not (FilterAttributeTilePosition a, BWAPI::TilePosition position) const
UnitGroup &	operator+= (const UnitGroup &other)
UnitGroup &	operator*= (const UnitGroup &other)
UnitGroup &	operator^= (const UnitGroup &other)
UnitGroup &	operator-= (const UnitGroup &other)
BWAPI::Unit *	getNearest (BWAPI::Position position) const
bool	contains (BWAPI::Unit *u) const
BWAPI::Position	getCenter () const
bool	attack (BWAPI::Position position) const
bool	attackUnit (BWAPI::Unit *target) const
bool	rightClick (BWAPI::Position position) const
bool	rightClick (BWAPI::Unit *target) const
bool	train (BWAPI::UnitType type) const
bool	build (BWAPI::TilePosition position, BWAPI::UnitType type) const
bool	buildAddon (BWAPI::UnitType type) const
bool	research (BWAPI::TechType tech) const
bool	upgrade (BWAPI::UpgradeType upgrade) const
bool	stop () const
bool	holdPosition () const
bool	patrol (BWAPI::Position position) const
bool	follow (BWAPI::Unit *target) const
bool	setRallyPoint (BWAPI::Position target) const
bool	setRallyPoint (BWAPI::Unit *target) const
bool	repair (BWAPI::Unit *target) const
bool	morph (BWAPI::UnitType type) const
bool	burrow () const
bool	unburrow () const
bool	siege () const
bool	unsiege () const
bool	cloak () const
bool	decloak () const
bool	lift () const
bool	land (BWAPI::TilePosition position) const
bool	load (BWAPI::Unit *target) const
bool	unload (BWAPI::Unit *target) const
bool	unloadAll () const
bool	unloadAll (BWAPI::Position position) const
bool	cancelConstruction () const
bool	haltConstruction () const
bool	cancelMorph () const
bool	cancelTrain () const
bool	cancelTrain (int slot) const
bool	cancelAddon () const
bool	cancelResearch () const
bool	cancelUpgrade () const
bool	useTech (BWAPI::TechType tech) const
bool	useTech (BWAPI::TechType tech, BWAPI::Position position) const
bool	useTech (BWAPI::TechType tech, BWAPI::Unit *target) const
	UnitGroup ()
	default constructor
	UnitGroup (groupObjective_t obj, BWAPI::Position pos)
	init constructor (with the objective of the group)
	UnitGroup (BWAPI::Position regroupPos)
	init constructor
	~UnitGroup ()
	destructor
BWAPI::Position	curPos () const
BWAPI::Position	pos () const
	return the average position of the group
BWAPI::Position	objPos () const
	return the average position of the objective
bool	empty () const
	check if the group is empty
int	nbUnits () const
	return the number of units that belong to the current group
void	moveTo (BWAPI::Position pos)
	move to the desired position
void	attackTo (const BWAPI::Position pos)
	attack to the desired position
void	patrolTo (BWAPI::Position pos)
	patrol to the desired position
void	stop ()
	stop the group
bool	canFulFillObj (Objective *obj) const
	check if the current group can fulfill the input objective
bool	requires (BWAPI::Unit *unit) const
	check if the current group requires the input type of unit
void	addUnit (BWAPI::Unit *unit)
	add a new unit to the group
Static Public Member Functions
static UnitGroup	getUnitGroup (const std::set< BWAPI::Unit * > units)
Protected Member Functions
void	updateAvgPos ()
	update the average position of the group
Protected Attributes
std::list< BWAPI::Unit * >	lUnits_
groupObjective_t	objective_
groupStatus_t	status_
BWAPI::Position	curPos_
BWAPI::Position	objPos_

---

Constructor & Destructor Documentation

UnitGroup::UnitGroup

(

)

default constructor

UnitGroup::UnitGroup	(	groupObjective_t	obj,
		BWAPI::Position	pos
	)

init constructor (with the objective of the group)

Parameters:

obj	: the objective of the group
pos	: the position associated to the objective

UnitGroup::UnitGroup

(

BWAPI::Position

regroupPos

)

init constructor

Parameters:

pos	: the position to regroup units

UnitGroup::~UnitGroup

(

)

destructor

---

Member Function Documentation

void UnitGroup::addUnit

(

BWAPI::Unit *

unit

)

add a new unit to the group

Parameters:

unit	: the input unit

bool UnitGroup::attack

(

BWAPI::Position

position

)

const

void UnitGroup::attackTo

(

const BWAPI::Position

pos

)

attack to the desired position

Parameters:

pos	: the position to go to

bool UnitGroup::attackUnit

(

BWAPI::Unit *

target

)

const

bool UnitGroup::build	(	BWAPI::TilePosition	position,
		BWAPI::UnitType	type
	)		const

bool UnitGroup::buildAddon

(

BWAPI::UnitType

type

)

const

bool UnitGroup::burrow

(

)

const

bool UnitGroup::cancelAddon

(

)

const

bool UnitGroup::cancelConstruction

(

)

const

bool UnitGroup::cancelMorph

(

)

const

bool UnitGroup::cancelResearch

(

)

const

bool UnitGroup::cancelTrain

(

)

const

bool UnitGroup::cancelTrain

(

int

slot

)

const

bool UnitGroup::cancelUpgrade

(

)

const

bool UnitGroup::canFulFillObj

(

Objective *

obj

)

const

check if the current group can fulfill the input objective

check if the current group can fulfill the inpût objective

Parameters:

obj	: the input objective

Returns:

true if the group can fulfill the objective

Here is the call graph for this function:

bool UnitGroup::cloak

(

)

const

bool UnitGroup::contains

(

BWAPI::Unit *

u

)

const

Here is the caller graph for this function:

BWAPI::Position UnitGroup::curPos

(

)

const [inline]

bool UnitGroup::decloak

(

)

const

bool UnitGroup::empty

(

)

const [inline]

check if the group is empty

Returns:

true if the group is empty

Here is the caller graph for this function:

bool UnitGroup::follow

(

BWAPI::Unit *

target

)

const

Position UnitGroup::getCenter

(

)

const

BWAPI::Unit * UnitGroup::getNearest

(

BWAPI::Position

position

)

const

static UnitGroup UnitGroup::getUnitGroup

(

const std::set< BWAPI::Unit * >

units

)

[inline, static]

bool UnitGroup::haltConstruction

(

)

const

bool UnitGroup::holdPosition

(

)

const

UnitGroup UnitGroup::inRadius	(	double	radius,
		BWAPI::Position	position
	)		const

Here is the caller graph for this function:

UnitGroup UnitGroup::inRegion

(

BWTA::Region *

region

)

const

bool UnitGroup::land

(

BWAPI::TilePosition

position

)

const

bool UnitGroup::lift

(

)

const

bool UnitGroup::load

(

BWAPI::Unit *

target

)

const

bool UnitGroup::morph

(

BWAPI::UnitType

type

)

const

void UnitGroup::moveTo

(

BWAPI::Position

pos

)

move to the desired position

Parameters:

pos	: the position to go to

int UnitGroup::nbUnits

(

)

const [inline]

return the number of units that belong to the current group

Returns:

the number of units that belong to the current group

UnitGroup UnitGroup::not

(

int

f1

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

UnitGroup UnitGroup::not	(	int	f1,
		int	f2
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::not	(	int	f1,
		int	f2,
		int	f3
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::not	(	int	f1,
		int	f2,
		int	f3,
		int	f4
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::not	(	int	f1,
		int	f2,
		int	f3,
		int	f4,
		int	f5
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::not	(	FliterAttributeScalar	a,
		const char *	compare,
		double	value
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::not	(	FliterAttributeScalar	a,
		const char *	compare,
		int	value
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::not

(

BWAPI::Player *

player

)

const

UnitGroup UnitGroup::not	(	FilterAttributeUnit	a,
		BWAPI::Unit *	unit
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::not	(	FilterAttributeType	a,
		BWAPI::UnitType	type
	)		const

UnitGroup UnitGroup::not	(	FilterAttributeType	a,
		BWAPI::TechType	type
	)		const

UnitGroup UnitGroup::not	(	FilterAttributeType	a,
		BWAPI::UpgradeType	type
	)		const

UnitGroup UnitGroup::not	(	FilterAttributeOrder	a,
		BWAPI::Order	type
	)		const

UnitGroup UnitGroup::not	(	FilterAttributePosition	a,
		BWAPI::Position	position
	)		const

UnitGroup UnitGroup::not	(	FilterAttributeTilePosition	a,
		BWAPI::TilePosition	position
	)		const

BWAPI::Position UnitGroup::objPos

(

)

const

return the average position of the objective

Returns:

the average position of the objective

UnitGroup UnitGroup::onlyNearestBaseLocation

(

BWTA::BaseLocation *

location

)

const

UnitGroup UnitGroup::onlyNearestChokepoint

(

BWTA::Chokepoint *

choke

)

const

UnitGroup UnitGroup::onlyNearestUnwalkablePolygon

(

BWTA::Polygon *

polygon

)

const

UnitGroup UnitGroup::operator()

(

int

f1

)

const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()	(	int	f1,
		int	f2
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()	(	int	f1,
		int	f2,
		int	f3
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()	(	int	f1,
		int	f2,
		int	f3,
		int	f4
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()	(	int	f1,
		int	f2,
		int	f3,
		int	f4,
		int	f5
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()	(	FliterAttributeScalar	a,
		const char *	compare,
		double	value
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()	(	FliterAttributeScalar	a,
		const char *	compare,
		int	value
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()

(

BWAPI::Player *

player

)

const

UnitGroup UnitGroup::operator()	(	FilterAttributeUnit	a,
		BWAPI::Unit *	unit
	)		const

Here is the call graph for this function:

UnitGroup UnitGroup::operator()	(	FilterAttributeType	a,
		BWAPI::UnitType	type
	)		const

UnitGroup UnitGroup::operator()	(	FilterAttributeType	a,
		BWAPI::TechType	type
	)		const

UnitGroup UnitGroup::operator()	(	FilterAttributeType	a,
		BWAPI::UpgradeType	type
	)		const

UnitGroup UnitGroup::operator()	(	FilterAttributeOrder	a,
		BWAPI::Order	type
	)		const

UnitGroup UnitGroup::operator()	(	FilterAttributePosition	a,
		BWAPI::Position	position
	)		const

UnitGroup UnitGroup::operator()	(	FilterAttributeTilePosition	a,
		BWAPI::TilePosition	position
	)		const

UnitGroup UnitGroup::operator*

(

const UnitGroup &

other

)

const

UnitGroup & UnitGroup::operator*=

(

const UnitGroup &

other

)

Here is the call graph for this function:

UnitGroup UnitGroup::operator+

(

const UnitGroup &

other

)

const

UnitGroup & UnitGroup::operator+=

(

const UnitGroup &

other

)

UnitGroup UnitGroup::operator-

(

const UnitGroup &

other

)

const

UnitGroup & UnitGroup::operator-=

(

const UnitGroup &

other

)

UnitGroup UnitGroup::operator^

(

const UnitGroup &

other

)

const

UnitGroup & UnitGroup::operator^=

(

const UnitGroup &

other

)

bool UnitGroup::patrol

(

BWAPI::Position

position

)

const

void UnitGroup::patrolTo

(

BWAPI::Position

pos

)

patrol to the desired position

Parameters:

pos	: the position to go to

BWAPI::Position UnitGroup::pos

(

)

const

return the average position of the group

Returns:

the average position of the group

bool UnitGroup::repair

(

BWAPI::Unit *

target

)

const

bool UnitGroup::requires

(

BWAPI::Unit *

unit

)

const

check if the current group requires the input type of unit

Parameters:

unit	: the input unit

Returns:

true if the group requires the input unit

bool UnitGroup::research

(

BWAPI::TechType

tech

)

const

bool UnitGroup::rightClick

(

BWAPI::Position

position

)

const

bool UnitGroup::rightClick

(

BWAPI::Unit *

target

)

const

bool UnitGroup::setRallyPoint

(

BWAPI::Position

target

)

const

bool UnitGroup::setRallyPoint

(

BWAPI::Unit *

target

)

const

bool UnitGroup::siege

(

)

const

void UnitGroup::stop

(

)

stop the group

bool UnitGroup::stop

(

)

const

bool UnitGroup::train

(

BWAPI::UnitType

type

)

const

bool UnitGroup::unburrow

(

)

const

bool UnitGroup::unload

(

BWAPI::Unit *

target

)

const

bool UnitGroup::unloadAll

(

)

const

bool UnitGroup::unloadAll

(

BWAPI::Position

position

)

const

bool UnitGroup::unsiege

(

)

const

void UnitGroup::updateAvgPos

(

)

[protected]

update the average position of the group

bool UnitGroup::upgrade

(

BWAPI::UpgradeType

upgrade

)

const

bool UnitGroup::useTech

(

BWAPI::TechType

tech

)

const

bool UnitGroup::useTech	(	BWAPI::TechType	tech,
		BWAPI::Position	position
	)		const

bool UnitGroup::useTech	(	BWAPI::TechType	tech,
		BWAPI::Unit *	target
	)		const

---

Member Data Documentation

BWAPI::Position UnitGroup::curPos_ [protected]

average postion of the group on the map

std::list<BWAPI::Unit*> UnitGroup::lUnits_ [protected]

list of units contained in the group

groupObjective_t UnitGroup::objective_ [protected]

objective of the group

BWAPI::Position UnitGroup::objPos_ [protected]

average postion of the objective of the group

groupStatus_t UnitGroup::status_ [protected]

status of the group

---

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

• SnippyHolloW-BroodwarBotQ-f01ab56/src/Macro/UnitGroup.h
• SnippyHolloW-BroodwarBotQ-f01ab56/src/Micro/UnitManager/UnitGroup.h
• SnippyHolloW-BroodwarBotQ-f01ab56/src/Macro/UnitGroup.cpp
• SnippyHolloW-BroodwarBotQ-f01ab56/src/Micro/UnitManager/UnitGroup.cpp