Class: Group#

Hierarchy#

Handle<group>
↳ Group

Constructors#

constructor#

new Group(): Group

Returns: Group

_{Defined in: handles/group.ts:10}

Properties#

handle#

• Readonly handle: group

_{Inherited from: Handle.handle
Defined in: handles/handle.ts:6}

Accessors#

first#

first(): Unit

bug May return null even if there are still units in the group. This happens when a unit in the group dies and decays since the group still holds a reference to that unit but that unit is pretty much null. See http://wc3c.net/showthread.php?t=104464.

Returns: Unit

_{Defined in: handles/group.ts:100}

id#

id(): number

Get the unique ID of the handle. The ID is recycled once you destroy the object.

Returns: number

The unique ID of a handle object.

_{Defined in: handles/handle.ts:18}

size#

size(): number

Returns: number

_{Defined in: handles/group.ts:104}

Methods#

addGroupFast#

addGroupFast(addGroup: Group): number

Parameters:#

Name	Type
`addGroup`	Group

Returns: number

_{Defined in: handles/group.ts:19}

addUnit#

addUnit(whichUnit: Unit): boolean

Parameters:#

Name	Type
`whichUnit`	Unit

Returns: boolean

_{Defined in: handles/group.ts:23}

clear#

clear(): void

Returns: void

_{Defined in: handles/group.ts:27}

destroy#

destroy(): void

Returns: void

_{Defined in: handles/group.ts:31}

enumUnitsInRange#

enumUnitsInRange(x: number, y: number, radius: number, filter: boolexpr | function): void

Parameters:#

Name	Type
`x`	number
`y`	number
`radius`	number
`filter`	boolexpr \| () => boolean

Returns: void

_{Defined in: handles/group.ts:35}

enumUnitsInRangeCounted#

enumUnitsInRangeCounted(x: number, y: number, radius: number, filter: boolexpr | function, countLimit: number): void

bug Causes irregular behavior when used with large numbers

Parameters:#

Name	Type
`x`	number
`y`	number
`radius`	number
`filter`	boolexpr \| () => boolean
`countLimit`	number

Returns: void

_{Defined in: handles/group.ts:42}

enumUnitsInRangeOfPoint#

enumUnitsInRangeOfPoint(whichPoint: Point, radius: number, filter: boolexpr | function): void

Parameters:#

Name	Type
`whichPoint`	Point
`radius`	number
`filter`	boolexpr \| () => boolean

Returns: void

_{Defined in: handles/group.ts:46}

enumUnitsInRangeOfPointCounted#

enumUnitsInRangeOfPointCounted(whichPoint: Point, radius: number, filter: boolexpr | function, countLimit: number): void

bug Causes irregular behavior when used with large numbers

Parameters:#

Name	Type
`whichPoint`	Point
`radius`	number
`filter`	boolexpr \| () => boolean
`countLimit`	number

Returns: void

_{Defined in: handles/group.ts:53}

enumUnitsInRect#

enumUnitsInRect(r: Rectangle, filter: boolexpr | function): void

Parameters:#

Name	Type
`r`	Rectangle
`filter`	boolexpr \| () => boolean

Returns: void

_{Defined in: handles/group.ts:57}

enumUnitsInRectCounted#

enumUnitsInRectCounted(r: Rectangle, filter: boolexpr | function, countLimit: number): void

bug Causes irregular behavior when used with large numbers

Parameters:#

Name	Type
`r`	Rectangle
`filter`	boolexpr \| () => boolean
`countLimit`	number

Returns: void

_{Defined in: handles/group.ts:64}

enumUnitsOfPlayer#

enumUnitsOfPlayer(whichPlayer: MapPlayer, filter: boolexpr | function): void

note In contrast to other Enum-functions this function enumarates units with locust.

Parameters:#

Name	Type
`whichPlayer`	MapPlayer
`filter`	boolexpr \| () => boolean

Returns: void

_{Defined in: handles/group.ts:71}

enumUnitsOfType#

enumUnitsOfType(unitName: string, filter: boolexpr | function): void

Parameters:#

Name	Type
`unitName`	string
`filter`	boolexpr \| () => boolean

Returns: void

_{Defined in: handles/group.ts:75}

enumUnitsOfTypeCounted#

enumUnitsOfTypeCounted(unitName: string, filter: boolexpr | function, countLimit: number): void

bug Causes irregular behavior when used with large numbers

Parameters:#

Name	Type
`unitName`	string
`filter`	boolexpr \| () => boolean
`countLimit`	number

Returns: void

_{Defined in: handles/group.ts:82}

enumUnitsSelected#

enumUnitsSelected(whichPlayer: MapPlayer, filter: boolexpr | function): void

Parameters:#

Name	Type
`whichPlayer`	MapPlayer
`filter`	boolexpr \| () => boolean

Returns: void

_{Defined in: handles/group.ts:86}

for#

for(callback: function): void

Parameters:#

Name	Type
`callback`	() => void

Returns: void

_{Defined in: handles/group.ts:90}

getUnitAt#

getUnitAt(index: number): Unit

Parameters:#

Name	Type
`index`	number

Returns: Unit

_{Defined in: handles/group.ts:114}

getUnits#

getUnits(): Unit[]

Returns: Unit[]

_{Defined in: handles/group.ts:108}

hasUnit#

hasUnit(whichUnit: Unit): boolean

Parameters:#

Name	Type
`whichUnit`	Unit

Returns: boolean

_{Defined in: handles/group.ts:118}

orderCoords#

orderCoords(order: string | number, x: number, y: number): void

Parameters:#

Name	Type
`order`	string \| number
`x`	number
`y`	number

Returns: void

_{Defined in: handles/group.ts:122}

orderImmediate#

orderImmediate(order: string | number): void

Parameters:#

Name	Type
`order`	string \| number

Returns: void

_{Defined in: handles/group.ts:130}

orderPoint#

orderPoint(order: string | number, whichPoint: Point): void

Parameters:#

Name	Type
`order`	string \| number
`whichPoint`	Point

Returns: void

_{Defined in: handles/group.ts:138}

orderTarget#

orderTarget(order: string | number, targetWidget: Widget | Unit): void

Parameters:#

Name	Type
`order`	string \| number
`targetWidget`	Widget \| Unit

Returns: void

_{Defined in: handles/group.ts:146}

removeGroupFast#

removeGroupFast(removeGroup: Group): number

Parameters:#

Name	Type
`removeGroup`	Group

Returns: number

_{Defined in: handles/group.ts:154}

removeUnit#

removeUnit(whichUnit: Unit): boolean

Parameters:#

Name	Type
`whichUnit`	Unit

Returns: boolean

_{Defined in: handles/group.ts:158}

fromHandle#

static fromHandle(handle: group): Group

Parameters:#

Name	Type
`handle`	group

Returns: Group

_{Defined in: handles/group.ts:162}

getEnumUnit#

static getEnumUnit(): Unit

Returns: Unit

_{Defined in: handles/group.ts:166}

getFilterUnit#

static getFilterUnit(): Unit

Returns: Unit

_{Defined in: handles/group.ts:170}