1. Epic GamesDeveloper
  3. AGameMode

AGameMode

GameMode is a subclass of GameModeBase 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/GameMode.h
Include #include "GameFramework/GameMode.h"

Syntax

UCLASS (MinimalAPI)  
class AGameMode : public AGameModeBase

Remarks

GameMode is a subclass of GameModeBase that behaves like a multiplayer match-based game. It has default behavior for picking spawn points and match state. If you want a simpler base, inherit from GameModeBase instead.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint32: 1 bDelayedStart Whether the game should immediately start when the first player logs in.
Protected variable UProperty Config bool bHandleDedicatedServerReplays If true, dedicated servers will record replays when HandleMatchHasStarted/HandleMatchHasStopped is called
Public variable UProperty TSubclassOf< class ULocalMessage > EngineMessageClass Contains strings describing localized game agnostic messages.
Public variable UProperty TArray< TObjectPtr< class APlayerState > > InactivePlayerArray PlayerStates of players who have disconnected from the server (saved in case they reconnect)
Protected variable UProperty Category, EditAnywhere float InactivePlayerStateLifeSpan Time a playerstate will stick around in an inactive state after a player logout
Protected variable UProperty Transient FName MatchState What match state we are currently in
Protected variable UProperty Category, EditAnywhere int32 MaxInactivePlayers The maximum number of inactive players before we kick the oldest ones out
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float MinRespawnDelay Minimum time before player can respawn after dying.
Public variable UProperty Category BlueprintReadOnly int32 NumBots Number of non-human players (AI controlled but participating as a player).
Public variable UProperty Category BlueprintReadOnly int32 NumPlayers Current number of human players.
Public variable UProperty Category BlueprintReadOnly int32 NumSpectators Current number of spectators.
Public variable UProperty Category BlueprintReadOnly int32 NumTravellingPlayers Number of players that are still traveling from a previous map

Constructors

  Type Name Description
Public function  

AGameMode ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category void Report that a match has failed due to unrecoverable error
Public function Virtual void Add PlayerState to the inactive list, remove from the active list
Public function Virtual void

Broadcast ( AActor* Sender,
const FString& Msg,
FName Type
)

 Broadcast a string to all players.
Public function Virtual void

BroadcastLocalized ( AActor* Sender,
TSubclassOf< ULocalMessage > Message,
int32 Switch,
APlayerState* RelatedPlayerState_1,
APlayerState* RelatedPlayerState_2,
UObject* OptionalObject
)

 Broadcast a localized message to all players.
Public function Virtual UFunction BlueprintCallable, Category void Transition from InProgress to WaitingPostMatch.
Public function Virtual bool Attempt to find and associate an inactive PlayerState with entering PC.
Public function Const UFunction BlueprintCallable, Category FName Returns the current match state, this is an accessor to protect the state machine flow
Public function Virtual FString Get local address
Public function Virtual bool Return true if we want to travel_absolute, used by RestartGame by default
Public function Virtual void

HandleDisconnect ( UWorld* InWorld,
UNetDriver* NetDriver
)

 Handles when a player is disconnected, before the session does
Protected function Virtual void Called when the match transitions to LeavingMap
Protected function Virtual void Called when the match transitions to Aborted
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 void  
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the match state is InProgress or other gameplay state
Protected function UFunction Category, Meta, BlueprintImplementableEvent void

K2_OnSetMatchState ( FName NewState
)

 Implementable event to respond to match state changes
Public function Virtual void

NotifyPendingConnectionLost ( const FUniqueNetIdRepl& ConnectionUniqueId
)

 Called when a connection closes before getting to PostLogin()
Protected function Virtual void Overridable virtual function to dispatch the appropriate transition functions before GameState and Blueprints get SetMatchState calls.
Public function Virtual void Override PC's PlayerState with the values in OldPlayerState as part of the inactive player handling
Public function Virtual bool  
Public function void Will remove the controller from the correct count then add them to the spectator count.
Public function Virtual void Called from CommitMapChange after unloading previous level and loading new level+sublevels.
Public function Virtual void

PreCommitMapChange ( const FString& PreviousMapName,
const FString& NextMapName
)

 Called from CommitMapChange before unloading previous level. Used for asynchronous level streaming
Protected function UFunction Category blueprintnativeevent bool Returns true if ready to End Match. Games should override this
Protected function UFunction Category blueprintnativeevent bool Returns true if ready to Start Match. Games should override this
Public function void Removes the passed in player controller from the correct count for player/spectator/tranistioning
Public function Virtual UFunction BlueprintCallable, Category void Restart the game, by default travel to the current map
Public function Virtual UFunction BlueprintCallable, Category exec void

Say ( const FString& Msg
)

 Exec command to broadcast a string to all players
Protected function Virtual void

SetMatchState ( FName NewState
)

 Updates the match state and calls the appropriate transition functions
Public function Virtual void SetViewTarget of player control on server change
Public function Virtual UFunction BlueprintCallable, Category void Transition from WaitingToStart to InProgress.

Overridden from AGameModeBase

  Type Name Description
Public function Virtual bool

CanServerTravel ( const FString& URL,
bool bAbsolute
)

 Returns true if allowed to server travel
Public function Virtual int32 Returns number of active human players, excluding spectators
Public function Virtual int32 Returns number of human players currently spectating
Public function Virtual void Handles reinitializing players that remained through a seamless level transition called from C++ for players that finished loading after the server
Public function Virtual Const bool Returns true if the match state is WaitingPostMatch or later
Public function Virtual Const bool Returns true if the match start callbacks have been called
Public function Virtual void

InitGame ( const FString& MapName,
const FString& Options,
FString& ErrorMessage
)

 Initialize the game.
Public function Virtual void Handles initializing a seamless travel player, handles logic similar to InitNewPlayer
Public function Virtual bool Returns true if replays will start/stop during gameplay starting/stopping
Public function Virtual void

Logout ( AController* Exiting
)

 Called when a Controller with a PlayerState leaves the game or is destroyed
Public function Virtual void

PostLogin ( APlayerController* NewPlayer
)

 Called after a successful login.
Public function Virtual void Called after a seamless level transition has been completed on the new GameMode.
Public function Virtual bool

SpawnPlayerFromSimulate ( const FVector& NewLocation,
const FRotator& NewRotation
)

 Used in the editor to spawn a PIE player after the game has already started
Public function Virtual void Transitions to calls BeginPlay on actors.
Public function Virtual void Start the transition out of the current map.

Overridden from AActor

  Type Name Description
Public function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page