Snippet Group Enum Functions

[Romek]

Enum Functions
By Romek​

Introduction:
I've believed until a few hours ago that all the GroupEnum functions do not overwrite the group which is passed to them.
After a bit of testing, however, I found that the group is actually cleared before the units are added to it. Artificial confirmed this.
These are just some simple functions which allow you to enum units without clearing the target group. I suggest you only use these if you really need to keep the units in the group as the natives are considerably faster.

Functions:

function EnumUnitsInRange takes group whichGroup, real x, real y, real radius, boolexpr filter returns nothing

function EnumUnitsInRangeCounted takes group whichGroup, real x, real y, real radius, boolexpr filter, integer limit returns nothing

function EnumUnitsInRangeOfLoc takes group whichGroup, location loc, real radius, boolexpr filter returns nothing

function EnumUnitsInRangeOfLocCounted takes group whichGroup, location loc, real radius, boolexpr filter, integer limit returns nothing

function EnumUnitsInRect takes group whichGroup, rect whichRect, boolexpr filter returns nothing

function EnumUnitsInRectCounted takes group whichGroup, rect whichRect, boolexpr filter, integer limit returns nothing

function EnumUnitsOfPlayer takes group whichGroup, player whichPlayer, boolexpr filter returns nothing

function EnumUnitsOfType takes group whichGroup, string name, boolexpr filter returns nothing

function EnumUnitsOfTypeCounted takes group whichGroup, string name, boolexpr filter, integer limit returns nothing

function EnumSelectedUnits takes group whichGroup, player whichPlayer, boolexpr filter returns nothing

The Code:

library EnumUnits 
    // ============================
    //  Enum Functions - By Romek
    // ============================

    globals
        private group G = CreateGroup()
        private group TempG
    endglobals
    
    private function Enum takes nothing returns nothing
        call GroupAddUnit(TempG, GetEnumUnit())
    endfunction
    
    function EnumUnitsInRange takes group whichGroup, real x, real y, real radius, boolexpr filter returns nothing
        call GroupEnumUnitsInRange(G, x, y, radius, filter)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsInRangeCounted takes group whichGroup, real x, real y, real radius, boolexpr filter, integer limit returns nothing
        call GroupEnumUnitsInRangeCounted(G, x, y, radius, filter, limit)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsInRangeOfLoc takes group whichGroup, location loc, real radius, boolexpr filter returns nothing
        call GroupEnumUnitsInRangeOfLoc(G, loc, radius, filter)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsInRangeOfLocCounted takes group whichGroup, location loc, real radius, boolexpr filter, integer limit returns nothing
        call GroupEnumUnitsInRangeOfLocCounted(G, loc, radius, filter, limit)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsInRect takes group whichGroup, rect whichRect, boolexpr filter returns nothing
        call GroupEnumUnitsInRect(G, whichRect, filter)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsInRectCounted takes group whichGroup, rect whichRect, boolexpr filter, integer limit returns nothing
        call GroupEnumUnitsInRectCounted(G, whichRect, filter, limit)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsOfPlayer takes group whichGroup, player whichPlayer, boolexpr filter returns nothing
        call GroupEnumUnitsOfPlayer(G, whichPlayer, filter)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsOfType takes group whichGroup, string name, boolexpr filter returns nothing
        call GroupEnumUnitsOfType(G, name, filter)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    function EnumUnitsOfTypeCounted takes group whichGroup, string name, boolexpr filter, integer limit returns nothing
        call GroupEnumUnitsOfTypeCounted(G, name, filter, limit)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction
    
    // EnumUnitsSelected() name was taken by a BJ ¬_¬
    function EnumSelectedUnits takes group whichGroup, player whichPlayer, boolexpr filter returns nothing
        call GroupEnumUnitsSelected(G, whichPlayer, filter)
        set TempG = whichGroup
        call ForGroup(G, function Enum)
        call GroupClear(G)
    endfunction

endlibrary

 

[Romek]

Bump. No replies in nearly a month

 

[Trollvottel]

Actually its like GroupAddGroup with the difference that you have to import a whole library, isnt it? and i dont see any use for it, i never was in a situation where i needed to add units into an existing group. Its not a really bad idea but it isnt worth to copy a whole library in your map because you can do it yourself in ~10 seconds (if you write fast enough).

 

[AceHart]

> No replies in nearly a month

Well, shouldn't that tell you something?

 

[T.s.e]

I don't see the use of this, what's wrong with the normal GroupEnumUnits natives?

 

[Romek]

I don't see the use of this, what's wrong with the normal GroupEnumUnits natives?

The natives overwrite the group. These don't.
Not really a massive problem, but in the rare case you want to keep the units in the group, you could use these.

It's only intended to be a small, yet useful (in some cases) snippet.