SC2Mapster.com Wiki

SC2 API / Functions / UnitGroupFilterAlliance

UnitGroupFilterAlliance

unitgroup UnitGroupFilterAlliance(unitgroup g,
                                   int player,
                                   int alliance,
                                   int max)

Filter a unit group by alliance.

Parameters

unitgroup g

Original unit group

int player

Player the alliance is going to be compared to

int alliance
  • 0 (c_allianceIdPassive)
  • 1 (c_allianceIdVision)
  • 2 (c_allianceIdControl)
  • 3 (c_allianceIdSpend)
  • 4 (c_allianceIdTrade)
  • 5 (c_allianceIdSeekHelp)
  • 6 (c_allianceIdGiveHelp)
  • 7 (c_allianceIdChat)
  • 8 (c_allianceIdDefeat)
  • 9 (c_allianceIdPushable)
int max
  • 0: No maximum
  • n: Maximum number of units in the group.

Examples

Example: Sample Usage
unitgroup UnitGroupAllUnits() {
  return UnitGroup(null, -1, null, null, 0);
}

int g = UnitGroupAllUnits();
int player = 1;
int alliance = c_allianceIdControl;

g = UnitGroupFilterAlliance(g, player, alliance, 0);
// Select all units that the player 1 can control

You must login to post a comment. Don't have an account? Register to get one!

Facts

Date created
Mar 27, 2010
Last updated
Mar 27, 2010

Author