1. Epic GamesDeveloper
  3. AGameState

AGameState

GameState is a subclass of GameStateBase that behaves like a multiplayer match-based game.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/GameState.h
Include #include "GameFramework/GameState.h"

Syntax

class AGameState : public AGameStateBase

Remarks

GameState is a subclass of GameStateBase that behaves like a multiplayer match-based game. It is tied to functionality in GameMode.

Variables

  Type Name Description
Public variable int32 ElapsedTime Elapsed game time since match has started.
Protected variable FName MatchState What match state we are currently in
Protected variable FName PreviousMatchState Previous map state, used to handle if multiple transitions happen per frame
Protected variable FTimerHandle TimerHandle_DefaultTimer Handle for efficient management of DefaultTimer timer

Constructors

  Type Name Description
Public function  

AGameState ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void Called periodically, overridden by subclasses
Public function Const FName Returns the current match state, this is an accessor to protect the state machine flow
Protected function Virtual void Called when the match transitions to LeavingMap
Protected function Virtual void Called when the map transitions to WaitingPostMatch
Protected function Virtual void Called when the state transitions to InProgress
Protected function Virtual void Called when the state transitions to WaitingToStart
Public function Virtual Const bool Returns true if we're in progress
Public function Virtual void Gives clients the chance to do something when time gets updates
Public function Virtual void Match state has changed
Public function void

SetMatchState ( FName NewState
)

 Updates the match state and calls the appropriate transition functions, only valid on server

Overridden from AGameStateBase

  Type Name Description
Public function Virtual Const float Returns how much time needs to be spent before a player can respawn
Public function Virtual Const float Returns the time that should be used as when a player started
Public function Virtual void Called by game mode to set the started play bool
Public function Virtual Const bool Returns true if match is WaitingPostMatch or later
Public function Virtual Const bool Returns true if the world has started match (called MatchStarted callbacks)
Public function Virtual void Called when the GameClass property is set (at startup for the server, after the variable has been replicated on clients)

Overridden from AActor

  Type Name Description
Public function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page