GroupPickRandomUnit

Parameters

whichGroup

group

comment

note

If the global bj_wantDestroyGroup is set to true then destroys the passed group whichGroup.

patch

1.00

Source

Blizzard.j (suggest an edit or discuss on Github)

return type

unit

Source code

function GroupPickRandomUnit takes group whichGroup returns unit
    // If the user wants the group destroyed, remember that fact and clear
    // the flag, in case it is used again in the callback.
    local boolean wantDestroy = bj_wantDestroyGroup
    set bj_wantDestroyGroup = false

    set bj_groupRandomConsidered = 0
    set bj_groupRandomCurrentPick = null
    call ForGroup(whichGroup, function GroupPickRandomUnitEnum)

    // If the user wants the group destroyed, do so now.
    if (wantDestroy) then
        call DestroyGroup(whichGroup)
    endif
    return bj_groupRandomCurrentPick
endfunction