1. Epic GamesDeveloper
  3. AGameStateBase

AGameStateBase

GameStateBase is a class that manages the game's global state, and is spawned by GameModeBase.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Game, NotPlaceable, BlueprintType, Blueprintable, MinimalAPI)  
class AGameStateBase : public AInfo

Remarks

GameStateBase is a class that manages the game's global state, and is spawned by GameModeBase. It exists on both the client and the server and is fully replicated.

Variables

  Type Name Description
Public variable UProperty Category BlueprintReadOnly Transient TObjectPtr< AGameModeBase > AuthorityGameMode Instance of the current game mode, exists only on the server.
Protected variable UProperty Transient replicatedusing bool bReplicatedHasBegunPlay Replicated when GameModeBase->StartPlay has been called so the client will also start play
Public variable UProperty Category BlueprintReadOnly Transient replicatedusing TSubclassOf< AGameModeBase > GameModeClass Class of the server's game mode, assigned by GameModeBase.
Protected variable uint32 NumServerWorldTimeSecondsDeltas The number of server world time deltas accumulated in SumServerWorldTimeSecondsDelta - used for computing the mean
Public variable UProperty Category BlueprintReadOnly Transient TArray< TObjectPtr< APlayerState > > PlayerArray Array of all PlayerStates, maintained on both server and clients (PlayerStates are always relevant)
Protected variable UProperty Transient replicatedusing float ReplicatedWorldTimeSeconds Server TimeSeconds. Useful for syncing up animation and gameplay.
Protected variable UProperty Transient replicatedusing double ReplicatedWorldTimeSecondsDouble  
Protected variable UProperty Transient float ServerWorldTimeSecondsDelta The difference from the local world's TimeSeconds and the server world's TimeSeconds.
Protected variable UProperty Category, EditDefaultsOnly float ServerWorldTimeSecondsUpdateFrequency Frequency that the server updates the replicated TimeSeconds from the world.
Public variable UProperty Category BlueprintReadOnly Transient replicatedusing TSubclassOf< ASpectatorPawn > SpectatorClass Class used by spectators, assigned by GameModeBase.
Protected variable double SumServerWorldTimeSecondsDelta Cumulative sum of computed server world time deltas for smoothed-averaging
Protected variable FTimerHandle TimerHandle_UpdateServerTimeSeconds Handle for efficient management of the UpdateServerTimeSeconds timer

Constructors

  Type Name Description
Public function  

AGameStateBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

AddPlayerState ( APlayerState* PlayerState
)

 Add PlayerState to the PlayerArray
Public function Virtual void Allow game states to react to asset packages being loaded asynchronously
Public function Const const AGameModeBase * Helper to return the default object of the GameModeBase class corresponding to this GameState.
Public function Const const T * Helper template to returns the GameModeBase default object cast to the right type
Public function Virtual Const UFunction BlueprintCallable, Category float Returns how much time needs to be spent before a player can respawn
Public function Virtual Const UFunction BlueprintCallable, Category float Returns the time that should be used as when a player started
Public function Const APlayerState * Returns the player state for a specified unique player Id
Public function Virtual Const UFunction BlueprintCallable, Category double Returns the simulated TimeSeconds on the server, will be synchronized on client and server
Public function Virtual void Called by game mode to set the started play bool
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the world has started play (called BeginPlay on actors)
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the match can be considered ended. Defaults to false.
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the world has started match (called MatchStarted callbacks)
Protected function Virtual UFunction void GameModeBase class notification callback.
Protected function Virtual UFunction void By default calls BeginPlay and StartMatch
Protected function Virtual UFunction void Allows clients to calculate ServerWorldTimeSecondsDelta
Protected function Virtual UFunction void Allows clients to calculate ServerWorldTimeSecondsDelta
Protected function Virtual UFunction void Callback when we receive the spectator class
Public function Virtual void Called when the GameClass property is set (at startup for the server, after the variable has been replicated on clients)
Public function Virtual void Called when the SpectatorClass property is set (at startup for the server, after the variable has been replicated on clients)
Public function Virtual void

RemovePlayerState ( APlayerState* PlayerState
)

 Remove PlayerState from the PlayerArray.
Public function Virtual void

SeamlessTravelTransitionCheckpoint ( bool bToTransitionMap
)

 Called during seamless travel transition twice (once when the transition map is loaded, once when destination map is loaded)
Protected function Virtual void Called periodically to update ReplicatedWorldTimeSecondsDouble

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

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns the properties used for network replication, this needs to be overridden by all actor classes with native replicated properties

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page