GetInvasionState: Difference between revisions

Latest revision as of 18:09, 2 July 2022

This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports.

int GetInvasionState (void)

Returns the current state of the Invasion game mode.

If Invasion is not the current game mode, this function returns -1.

This article lists no examples, please add one.

@@ Line 1: / Line 1: @@
+{{ACSWarning}}
 int '''GetInvasionState''' (void)
-== Return value ==
+== Usage ==
+Returns the current state of the [[Game Modes#Invasion|Invasion]] game mode.
-If Invasion is enabled, the current state of the game mode is returned. Possible states are listed in the following table:
+=== Return value ===
+* '''IS_WAITINGFORPLAYERS''' = 0
+* '''IS_FIRSTCOUNTDOWN''' = 1
+* '''IS_INPROGRESS''' = 2
+* '''IS_BOSSFIGHT''' = 3
+* '''IS_WAVECOMPLETE''' = 4
+* '''IS_COUNTDOWN''' = 5
+* '''IS_MISSIONFAILED''' = 6
-{| class="wikitable"
+If Invasion is not the current game mode, this function returns -1.
-|-
-! style="padding: 6px;"| State
-|-
-| style="padding: 6px;"| IS_WAITINGFORPLAYERS <span style="color: #666;">(0)</span>
-|-
-| style="padding: 6px;"| IS_FIRSTCOUNTDOWN <span style="color: #666;">(1)</span>
-|-
-| style="padding: 6px;"| IS_INPROGRESS <span style="color: #666;">(2)</span>
-|-
-| style="padding: 6px;"| IS_BOSSFIGHT <span style="color: #666;">(3)</span>
-|-
-| style="padding: 6px;"| IS_WAVECOMPLETE <span style="color: #666;">(4)</span>
-|-
-| style="padding: 6px;"| IS_COUNTDOWN <span style="color: #666;">(5)</span>
-|-
-| style="padding: 6px;"| IS_MISSIONFAILED <span style="color: #666;">(6)</span>
-|}
-If Invasion is not enabled, -1 is returned.
+== Examples ==
+{{noexamples}}
-[[Category: ACS Functions]]
+== See also ==
+* [[GetGameModeState]]
+[[Category: ACS functions]]