# Idle Units For Player
Grammar — Idle workersOnly|Workers/Units for player player
Flags —Native
|Function
Returns a unit group that contains all of a player’s idle units.
# Arguments
int
— Playerbool
[ preset::IdleWorkerOption ] — Workers Only
Returns — unitgroup
native unitgroup UnitGroupIdle(
int player,
bool workerOnly,
);
# Related
Category: Unit Group / Useful Unit Groups
- [F] —
unitgroup
— Empty Unit Group — ( UnitGroupEmpty ) - [F] —
unitgroup
— Idle Units For Player — ( UnitGroupIdle ) - [F] —
unitgroup
— Convert Unit To Unit Group — ( libNtve_gf_ConvertUnitToUnitGroup ) - [F] —
unitgroup
— Units In Region Matching Condition — ( UnitGroup ) - [F] —
int
— Unit Count In Region Matching Condition — ( UnitCount ) - [F] —
unitgroup
— Units Near Point Matching Condition — ( UnitGroupSearch ) - [F] —
unitgroup
— Units In Region With Alliance To Player — ( UnitGroupAlliance ) - [F] —
int
— Unit Count In Region With Alliance To Player — ( UnitCountAlliance ) - [F] —
unitgroup
— Units In Region With Alliance To Player Matching Condition — ( libNtve_gf_UnitsInRegionWithAllianceToPlayerMatchingCondition ) - [F] —
unitgroup
— Units In Unit Group For Player — ( UnitGroupFilterPlayer ) - [F] —
unitgroup
— Units In Unit Group Matching Condition — ( UnitGroupFilter ) - [F] —
unitgroup
— Units In Unit Group Targetable As — ( UnitGroupFilterPlane ) - [F] —
unitgroup
— Units In Unit Group With Alliance — ( UnitGroupFilterAlliance ) - [F] —
unitgroup
— Units In Unit Group With Custom Value — ( libNtve_gf_UnitsInUnitGroupWithCustomValue ) - [F] —
unitgroup
— Units In Unit Group Within Region — ( UnitGroupFilterRegion )
# Examples
# campaigns/void.sc2campaign
// L7404
UnitGroupIdle(gv_p01_USER, true)
// L2730
UnitGroupIdle(gv_pLAYER_02_DOMINION2, false)
// L4440
UnitGroupIdle(UnitGetOwner(auto44AAC7FE_var), false)
// L7632
UnitGroupIdle(gv_pLAYER_03_KERRIGAN, false)
// L7404
UnitGroupIdle(gv_p01_USER, true)
// L2730
UnitGroupIdle(gv_pLAYER_02_DOMINION2, false)
// L4440
UnitGroupIdle(UnitGetOwner(auto44AAC7FE_var), false)
// L7632
UnitGroupIdle(gv_pLAYER_03_KERRIGAN, false)
# mods/heroesbrawlmods/brawlmapmods/coop/deadmansstand.stormmod
// L1826
UnitGroupIdle(libCore_gv_cOMPUTER_TeamChaos, false)
// L7129
UnitGroupIdle(libCore_gv_cOMPUTER_TeamChaos, false)
# mods/novastoryassets.sc2mod
// L2289
UnitGroupIdle(gv_pLAYER_02_REIGEL, true)
// L2294
UnitGroupIdle(gv_pLAYER_02_REIGEL, true)
// L2299
UnitGroupIdle(gv_pLAYER_02_REIGEL, true)
// L2289
UnitGroupIdle(gv_pLAYER_02_REIGEL, true)
// L2294
UnitGroupIdle(gv_pLAYER_02_REIGEL, true)
// L2299
UnitGroupIdle(gv_pLAYER_02_REIGEL, true)