Skip to content

GameState ​

The state of a game.

Kind: Enum

Namespace: ConnectorLib.JSON

Inheritance: IComparable → IConvertible → IFormattable → ISpanFormattable

Public Attributes

GameState

Unknown

The game state is unknown.

GameState

Error

The game is in an errored or crashed state.

GameState

Unmodded

The game does not have the required mod(s) installed.

GameState

BadGameSettings

The current game settings are not compatible with Crowd Control.

GameState

WrongVersion

The game is the wrong version.

GameState

NotFocused

The game is not focused.

GameState

Loading

The game is in a loading state.

GameState

InLevel

The game is running in a standard gameplay mode.

GameState

Ready

GameState

TitleScreen

The game is on the title screen or other title menu (e.g. Load Game Menu).

GameState

Credits

The game is playing the credits or is otherwise finished with the main game content.

GameState

Menu

The game is in a menu other than the pause or title menus.

GameState

Paused

The game is paused.

GameState

WrongMode

The game is in an alternate game mode.

GameState

SafeArea

The game is in a safe area.

GameState

StartingArea

The game is in the starting area.

GameState

Dialogue

The game is in a dialogue scene.

GameState

Cutscene

The game is in a cutscene.

GameState

BadPlayerState

The player is not in a state to receive effects (e.g. The player is dead, regenerating, missing, etc).

GameState

InputLocked

The game is not currently accepting input.

GameState

Map

The game is in a map state such as a world map or overworld.

GameState

UntimedArea

The game is in an untimed area.

GameState

InCombat

The game is in a combat state such as a boss fight or enemy encounter.

GameState

NotInCombat

The game is in a non-combat scene such as a cutscene or tutorial.

GameState

PipelineBusy

The game message queue is busy or full and cannot process any more messages.

GameState

NotReady

The game is in a state that is not ready to receive effects but is not well-described by other states.

Enums

GameState

[Unknown = 0, Error = -1, Unmodded = -2, BadGameSettings = -3, WrongVersion = -4, NotFocused = -5, Loading = -6, InLevel = 1, Ready = 1, TitleScreen = -17, Credits = -18, Menu = -13, Paused = -7, WrongMode = -8, SafeArea = -9, StartingArea = -19, Dialogue = -20, Cutscene = -11, BadPlayerState = -12, InputLocked = -21, Map = -14, UntimedArea = -10, InCombat = -15, NotInCombat = -16, PipelineBusy = -128, NotReady = -2147483648]

The state of a game.