# Wave State

Grammar — Get the state of wave waveRef
Flags — Native | Function

Returns the state of a wave.

# Arguments

• wave — Wave

Returns — int

native int AIWaveState(wave w);

# Related

Category: AI Advanced / Waves / Functions

• [F] — waveinfo — Create Wave Info — ( AIWaveInfoCreate )
• [F] — waveinfo — Create Wave Info From Wave — ( AIWaveInfo )
• [F] — wave — Create Wave — ( AIWaveCreate )
• [F] — int — Wave Unit Count — ( AIWaveUnitCount )
• [F] — int — Wave State — ( AIWaveState )
• [F] — wavetarget — Wave Target Unit — ( AIWaveTargetUnit )
• [F] — wavetarget — Wave Target UnitGroup — ( AIWaveTargetUnitGroup )
• [F] — wavetarget — Wave Target Unit Point — ( AIWaveTargetUnitPoint )
• [F] — wavetarget — Wave Target Point — ( AIWaveTargetPoint )
• [F] — wavetarget — Wave Target Player — ( AIWaveTargetPlayer )
• [F] — wavetarget — Wave Target Melee — ( AIWaveTargetMelee )
• [F] — wavetarget — Wave Target Melee Harass — ( AIWaveTargetMeleeHarass )
• [F] — wavetarget — Wave Target Merge — ( AIWaveTargetMerge )
• [F] — wavetarget — Wave Target Patrol — ( AIWaveTargetPatrol )
• [F] — wavetarget — Wave Target Escort — ( AIWaveTargetEscort )
• [F] — wavetarget — Wave Target Escort No Leash — ( AIWaveTargetEscortNL )
• [F] — wavetarget — Wave Target Gather Offense — ( AIWaveTargetGatherO )
• [F] — wavetarget — Wave Target Gather Defense — ( AIWaveTargetGatherD )
• [F] — wavetarget — Wave Target Harass Retreat — ( AIWaveHarassRetreat )
• [F] — wavetarget — Wave Target Region — ( AIWaveTargetRegion )
• [F] — wavetarget — Wave Get Target — ( AIWaveGetTarget )
• [F] — bool — Is Wave In Combat — ( AIWaveIsInCombat )
• [F] — int — Wave Time In Combat — ( AIWaveGetTimeInCombat )
• [F] — int — Wave Time Since Combat — ( AIWaveGetTimeSinceCombat )
• [F] — int — Wave Time Since Ordered — ( AIWaveGetTimeSinceOrdered )
• [F] — int — Wave Eval — ( AIWaveEval )
• [F] — int — Wave Eval Ratio — ( AIWaveEvalRatio )
• [F] — int — Eval Ratio — ( AIEvalRatio )
• [F] — wave — Wave Get — ( AIWaveGet )
• [F] — int — Wave Type — ( AIWaveType )
• [F] — point — Get Best Attack Target Point — ( AIGetBestTarget )
• [F] — string — Wave To String — ( AIWaveToString )
• [F] — text — Wave To Text — ( AIWaveToText )

# Examples

# mods/core.sc2mod

— MeleeWaveAI.galaxy

// L59
AIWaveState(w)

// L83
AIWaveState(w)

// L88
AIWaveState(w)

// L106
AIWaveState(w)

// L111
AIWaveState(w)

// L136
AIWaveState(w)

// L156
AIWaveState(w)

// L199
AIWaveState(w)

// L269
AIWaveState(w)

// L284
AIWaveState(w)

# mods/core.sc2mod

— TactProtAI.galaxy

// L615
AIWaveState(curWave)

// L1500
AIWaveState(curWave)

# mods/core.sc2mod

— TactTerrAI.galaxy

// L506
AIWaveState(curWave)

# mods/starcoop/starcoop.sc2mod

— TactProtAI.galaxy

// L594
AIWaveState(curWave)

// L1501
AIWaveState(curWave)

# mods/starcoop/starcoop.sc2mod

— TactTerrAI.galaxy

// L486
AIWaveState(curWave)

# mods/warcoop/warclassicsystem.sc2mod

— TacticalAIWar3.galaxy

// L84
AIWaveState(w)

# mods/warcoop/warmeleeai.sc2mod

— MeleeWaveAI.galaxy

// L189
AIWaveState(w)

// L213
AIWaveState(w)

// L218
AIWaveState(w)

// L240
AIWaveState(w)

// L252
AIWaveState(w)

// L292
AIWaveState(w)

// L358
AIWaveState(w)

// L373
AIWaveState(w)

// L495
AIWaveState(waveAttack)

// L520
AIWaveState(waveAttack)

# mods/warcoop/warmeleeai.sc2mod

— Orc.galaxy

// L428
AIWaveState(AIWaveGet(player,c_waveMain))