SetCurrentGameMode: Difference between revisions

From Zandronum Wiki
No edit summary
Tag: Source edit
m (caps)
Tag: Source edit
 
Line 25: Line 25:
** [[Game_Modes#Domination|Domination]]
** [[Game_Modes#Domination|Domination]]


=== Return Value ===
=== Return value ===
Returns 1 if the game mode was changed, or 0 if it wasn't. There are several reasons why a game mode might not change:
Returns 1 if the game mode was changed, or 0 if it wasn't. There are several reasons why a game mode might not change:
* The new game mode either doesn't exist, or is already being played.
* The new game mode either doesn't exist, or is already being played.

Latest revision as of 00:45, 3 July 2022

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

int SetCurrentGameMode (str gamemode)

Usage

Changes the current game mode, which also resets the game upon success. This requires players to reconnect to the server when it happens.

Parameters

Return value

Returns 1 if the game mode was changed, or 0 if it wasn't. There are several reasons why a game mode might not change:

  • The new game mode either doesn't exist, or is already being played.
  • The current level cannot support the new game mode (e.g. no team starts in a team-based game mode, no deathmatch starts in a deathmatch-based game mode, or no coop starts in a cooperative-based game mode).
  • The new game mode is Duel and there's more than two players already in the game.
  • The result sequence is currently active. Refer to GetGameModeState.

Examples

This article lists no examples, please add one.