# Units Of Wave

Grammar — Units of wave
Flags — Native | Function

Returns the group of units that belong to a wave.

# Arguments

• wave — Wave

Returns — unitgroup

native unitgroup AIWaveGetUnits(wave w);

# Related

Category: AI / MiscCampaign / Functions

• [F] — bool — AI Time Is Paused — ( AITimeIsPaused )
• [F] — fixed — Elapsed AI Time — ( AIGetTime )
• [F] — wave — Wave Of Unit — ( AIUnitGetWave )
• [F] — unitgroup — Units Of Wave — ( AIWaveGetUnits )
• [F] — unitgroup — Escorts Of Unit — ( AIGetAllEscorts )
• [F] — unitgroup — Escorts Of Unit Group — ( AIGetAllEscortsGroup )
• [F] — unitgroup — Units In Waves With Target — ( AIGetUnitsInWavesWithTarget )
• [F] — bool — Unit Is Script Controlled — ( AIIsScriptControlled )
• [F] — bool — Unit Is Unavailable For Wave Use — ( AIIsNotUsableInWaves )
• [F] — bool — Unit Is Suicidal — ( AIIsSuicideUnit )
• [F] — int — Difficulty Value (Integer) — ( libNtve_gf_DifficultyValueInt )
• [F] — fixed — Difficulty Value (Real) — ( libNtve_gf_DifficultyValueFixed )
• [F] — string [ gamelink::Unit ] — Difficulty Value (Unit Type) — ( libNtve_gf_DifficultyValueUnitType )
• [F] — bool — Difficulty Is (one) — ( )
• [F] — bool — Difficulty Is (two) — ( )
• [F] — bool — Difficulty High — ( )
• [F] — bool — Difficulty Low — ( )
• [F] — point — Random Spawn Point — ( AIRandomSpawnPoint )

# Examples

# campaigns/liberty.sc2campaign

— MapScript.galaxy

// L3669
AIWaveGetUnits(AIUnitGetWave(EventUnit()))

// L3669
AIWaveGetUnits(AIUnitGetWave(EventUnit()))

// L2382
AIWaveGetUnits(EventPlayerWave())

// L3327
AIWaveGetUnits(lv_triggeringWave)

// L3659
AIWaveGetUnits(gv_currentWave)

// L3749
AIWaveGetUnits(gv_currentWave)

// L3999
AIWaveGetUnits(gv_currentWave)

// L4269
AIWaveGetUnits(gv_currentWave)

// L4364
AIWaveGetUnits(gv_currentWave)

// L4438
AIWaveGetUnits(EventPlayerWave())

// L4657
AIWaveGetUnits(EventPlayerWave())

// L4197
AIWaveGetUnits(cai_wave_createdWave(1, gv_pLAYER_04_PROTOSS_RED))

// L669
AIWaveGetUnits(gv_cleanserWaves[lp_cleanserTeam])

// L677
AIWaveGetUnits(gv_cleanserWaves[lp_cleanserTeam])

// L683
AIWaveGetUnits(gv_cleanserWaves[lp_cleanserTeam])

// L4509
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L4700
AIWaveGetUnits(gv_cleanserWaves[lv_index])

// L4703
AIWaveGetUnits(gv_cleanserWaves[lv_index])

// L4758
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L4818
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L4822
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L7058
AIWaveGetUnits(cai_wave_createdWave(3, gv_pLAYER_07_DOMINION_LEFT))

// L7427
AIWaveGetUnits(cai_wave_createdWave(10, gv_pLAYER_04_DOMINION_RIGHT))

// L4197
AIWaveGetUnits(cai_wave_createdWave(1, gv_pLAYER_04_PROTOSS_RED))

// L669
AIWaveGetUnits(gv_cleanserWaves[lp_cleanserTeam])

// L677
AIWaveGetUnits(gv_cleanserWaves[lp_cleanserTeam])

// L683
AIWaveGetUnits(gv_cleanserWaves[lp_cleanserTeam])

// L4509
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L4700
AIWaveGetUnits(gv_cleanserWaves[lv_index])

// L4703
AIWaveGetUnits(gv_cleanserWaves[lv_index])

// L4758
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L4818
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L4822
AIWaveGetUnits(gv_cleanserWaves[gv_cleanserWaveCount])

// L7058
AIWaveGetUnits(cai_wave_createdWave(3, gv_pLAYER_07_DOMINION_LEFT))

// L7427
AIWaveGetUnits(cai_wave_createdWave(10, gv_pLAYER_04_DOMINION_RIGHT))

// L3327
AIWaveGetUnits(lv_triggeringWave)

// L3659
AIWaveGetUnits(gv_currentWave)

// L3749
AIWaveGetUnits(gv_currentWave)

// L3999
AIWaveGetUnits(gv_currentWave)

// L4269
AIWaveGetUnits(gv_currentWave)

// L4364
AIWaveGetUnits(gv_currentWave)

// L4438
AIWaveGetUnits(EventPlayerWave())

// L4657
AIWaveGetUnits(EventPlayerWave())

// L2382
AIWaveGetUnits(EventPlayerWave())

// L2775
AIWaveGetUnits(EventPlayerWave())

// L2776
AIWaveGetUnits(EventPlayerWave())

// L2779
AIWaveGetUnits(EventPlayerWave())

// L2819
AIWaveGetUnits(EventPlayerWave())

// L2820
AIWaveGetUnits(EventPlayerWave())

// L2823
AIWaveGetUnits(EventPlayerWave())

// L2863
AIWaveGetUnits(EventPlayerWave())

// L2864
AIWaveGetUnits(EventPlayerWave())

// L2867
AIWaveGetUnits(EventPlayerWave())

// L2908
AIWaveGetUnits(EventPlayerWave())

// L3386
AIWaveGetUnits(EventPlayerWave())

// L3445
AIWaveGetUnits(EventPlayerWave())

// L4554
AIWaveGetUnits(EventPlayerWave())

// L4606
AIWaveGetUnits(EventPlayerWave())

// L4629
AIWaveGetUnits(EventPlayerWave())

// L4629
AIWaveGetUnits(EventPlayerWave())

// L5265
AIWaveGetUnits(EventPlayerWave())

// L3433
AIWaveGetUnits(EventPlayerWave())

// L3485
AIWaveGetUnits(EventPlayerWave())

// L670
AIWaveGetUnits(lv_attackWave)

// L2573
AIWaveGetUnits(lv_attackWave)

// L656
AIWaveGetUnits(cai_wave_createdWave(1, gv_pLAYER_02_DOMINION5))

// L659
AIWaveGetUnits(cai_wave_createdWave(4, gv_pLAYER_02_DOMINION5))

// L662
AIWaveGetUnits(cai_wave_createdWave(5, gv_pLAYER_02_DOMINION5))

// L4941
AIWaveGetUnits(AIUnitGetWave(UnitGroupUnit(UnitGroup(null, gv_pLAYER_03_ARTANIS, gv_voidChasm[1].lv_spawnSafetyRegion, UnitFilter(0, 0, (1 << c_targetFilterStructure) | (1 << c_targetFilterMissile), (1 << (c_targetFilterDead - 32)) | (1 << (c_targetFilterHidden - 32))), 0), 1)))

// L2775
AIWaveGetUnits(EventPlayerWave())

// L2776
AIWaveGetUnits(EventPlayerWave())

// L2779
AIWaveGetUnits(EventPlayerWave())

// L2819
AIWaveGetUnits(EventPlayerWave())

// L2820
AIWaveGetUnits(EventPlayerWave())

// L2823
AIWaveGetUnits(EventPlayerWave())

// L2863
AIWaveGetUnits(EventPlayerWave())

// L2864
AIWaveGetUnits(EventPlayerWave())

// L2867
AIWaveGetUnits(EventPlayerWave())

// L2908
AIWaveGetUnits(EventPlayerWave())

// L3386
AIWaveGetUnits(EventPlayerWave())

// L3445
AIWaveGetUnits(EventPlayerWave())

// L4554
AIWaveGetUnits(EventPlayerWave())

// L4606
AIWaveGetUnits(EventPlayerWave())

// L4629
AIWaveGetUnits(EventPlayerWave())

// L4629
AIWaveGetUnits(EventPlayerWave())

// L5265
AIWaveGetUnits(EventPlayerWave())

// L3433
AIWaveGetUnits(EventPlayerWave())

// L3485
AIWaveGetUnits(EventPlayerWave())

// L670
AIWaveGetUnits(lv_attackWave)

// L2573
AIWaveGetUnits(lv_attackWave)

// L656
AIWaveGetUnits(cai_wave_createdWave(1, gv_pLAYER_02_DOMINION5))

// L659
AIWaveGetUnits(cai_wave_createdWave(4, gv_pLAYER_02_DOMINION5))

// L662
AIWaveGetUnits(cai_wave_createdWave(5, gv_pLAYER_02_DOMINION5))

// L4941
AIWaveGetUnits(AIUnitGetWave(UnitGroupUnit(UnitGroup(null, gv_pLAYER_03_ARTANIS, gv_voidChasm[1].lv_spawnSafetyRegion, UnitFilter(0, 0, (1 << c_targetFilterStructure) | (1 << c_targetFilterMissile), (1 << (c_targetFilterDead - 32)) | (1 << (c_targetFilterHidden - 32))), 0), 1)))

// L4360
AIWaveGetUnits(EventPlayerWave())

// L7749
AIWaveGetUnits(EventPlayerWave())

// L8067
AIWaveGetUnits(EventPlayerWave())

// L3622
AIWaveGetUnits(EventPlayerWave())

// L4829
AIWaveGetUnits(EventPlayerWave())

// L4360
AIWaveGetUnits(EventPlayerWave())