GetGameModeState

From Zandronum Wiki
Revision as of 15:19, 21 August 2016 by DrinkyBird (talk | contribs) (Created page with "int '''GetGameModeState''' (void) Return values are: GAMESTATE_UNSPECIFIED = -1, GAMESTATE_WAITFORPLAYERS = 0, GAMESTATE_COUNTDOWN = 1, GAMESTATE_INPROGRESS...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

int GetGameModeState (void)

Return values are:

   GAMESTATE_UNSPECIFIED = -1,
   GAMESTATE_WAITFORPLAYERS = 0,
   GAMESTATE_COUNTDOWN = 1,
   GAMESTATE_INPROGRESS = 2,
   GAMESTATE_INRESULTSEQUENCE = 3.

GAMESTATE_WAITFORPLAYERS

In Survival, Invasion, Duel, Last Man Standing and Possession, this result is returned when there are not enough players to start the game.

In other non-cooperative gamemodes, this result is returned when there are fewer than two players in the game.

In cooperative, this result is returned when there are no players in the game.

GAMESTATE_COUNTDOWN

This result is returned the match is in the middle of a before-match countdown.

GAMESTATE_INPROGRESS

This result is returned while the match is in progress.

GAMESTATE_INRESULTSEQUENCE

In Survival or Invasion, this result is returned when the "Mission Failed" message has appeared.

In Duel or Last Man Standing, this result is returned during the victory screen.

In all other gamemodes, this result is returned during the delay at the end of the level.