UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
GameDelegates.h File Reference
#include "CoreMinimal.h"

Go to the source code of this file.

Classes

class  FGameDelegates
 

Macros

#define DEFINE_GAME_DELEGATE(DelegateType)
 
#define DEFINE_GAME_DELEGATE_TYPED(DelegateVariable, DelegateType)
 

Typedefs

typedef const TMap< FName, FString > FAssignLayerChunkMap
 
typedef TMap< FString, FString > StringStringMap
 

Enumerations

enum class  EGameDelegates_SaveGame : short {
  MaxSize , Icon , Title , SubTitle ,
  Detail
}
 

Functions

 DECLARE_MULTICAST_DELEGATE_ThreeParams (FModifyCookDelegate, TConstArrayView< const ITargetPlatform * >, TArray< FName > &, TArray< FName > &)
 
 DECLARE_DELEGATE_FourParams (FAssignLayerChunkDelegate, const FAssignLayerChunkMap *, const FString &, const int32, int32 &)
 
 DECLARE_DELEGATE_ThreeParams (FExtendedSaveGameInfoDelegate, const TCHAR *, const EGameDelegates_SaveGame, FString &)
 
 DECLARE_DELEGATE_FiveParams (FWebServerActionDelegate, int32, const FString &, const FString &, const StringStringMap &, StringStringMap &)
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FPreCommitMapChangeDelegate, const FString &, const FString &)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FPendingConnectionLostDelegate, const FUniqueNetIdRepl &)
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FHandleDisconnectDelegate, class UWorld *, class UNetDriver *)
 
 DECLARE_DELEGATE_RetVal (TUniquePtr< class ICookedEditorPackageManager >, FCookedEditorPackageManagerFactoryDelegate)
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FViewTargetChangedDelegate, class APlayerController *, class AActor *, class AActor *)
 

Macro Definition Documentation

◆ DEFINE_GAME_DELEGATE

#define DEFINE_GAME_DELEGATE (   DelegateType)
Value:
public: F##DelegateType& Get##DelegateType() { return DelegateType; } \
private: F##DelegateType DelegateType;

◆ DEFINE_GAME_DELEGATE_TYPED

#define DEFINE_GAME_DELEGATE_TYPED (   DelegateVariable,
  DelegateType 
)
Value:
public: DelegateType& Get##DelegateVariable() { return DelegateVariable; } \
private: DelegateType DelegateVariable;
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

Typedef Documentation

◆ FAssignLayerChunkMap

Delegate to assign a disc layer to a chunk

◆ StringStringMap

typedef TMap<FString, FString> StringStringMap

A delegate for a web server running in engine to tell the game about events received from a client, and for game to respond to the client

Enumeration Type Documentation

◆ EGameDelegates_SaveGame

Collection of delegates for various components to call into game code

Enumerator
MaxSize 
Icon 
Title 
SubTitle 
Detail 

Function Documentation

◆ DECLARE_DELEGATE_FiveParams()

DECLARE_DELEGATE_FiveParams ( FWebServerActionDelegate  ,
int32  ,
const FString &  ,
const FString &  ,
const StringStringMap ,
StringStringMap  
)

◆ DECLARE_DELEGATE_FourParams()

DECLARE_DELEGATE_FourParams ( FAssignLayerChunkDelegate  ,
const FAssignLayerChunkMap ,
const FString &  ,
const int32  ,
int32  
)

◆ DECLARE_DELEGATE_RetVal()

Delegate to allow game to use a custom ICookedEditorPackageManager class

◆ DECLARE_DELEGATE_ThreeParams()

DECLARE_DELEGATE_ThreeParams ( FExtendedSaveGameInfoDelegate  ,
const TCHAR ,
const EGameDelegates_SaveGame  ,
FString &   
)

A delegate for platforms that need extra information to flesh out save data information (name of an icon, for instance)

◆ DECLARE_MULTICAST_DELEGATE_OneParam()

DECLARE_MULTICAST_DELEGATE_OneParam ( FPendingConnectionLostDelegate  ,
const FUniqueNetIdRepl  
)

Delegate called when a connection is lost, but there is no owning actor to handle it

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [1/2]

DECLARE_MULTICAST_DELEGATE_ThreeParams ( FModifyCookDelegate  ,
TConstArrayView< const ITargetPlatform * >  ,
TArray< FName > &  ,
TArray< FName > &   
)

Delegate to modify cooking behavior - return extra packages to cook, load up the asset registry, etc

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [2/2]

DECLARE_MULTICAST_DELEGATE_ThreeParams ( FViewTargetChangedDelegate  ,
class APlayerController ,
class AActor ,
class AActor  
)

Delegate to inform those interested that a view target has changed.

◆ DECLARE_MULTICAST_DELEGATE_TwoParams() [1/2]

DECLARE_MULTICAST_DELEGATE_TwoParams ( FHandleDisconnectDelegate  ,
class UWorld ,
class UNetDriver  
)

Delegate to handle when a connection is disconnecting

◆ DECLARE_MULTICAST_DELEGATE_TwoParams() [2/2]

DECLARE_MULTICAST_DELEGATE_TwoParams ( FPreCommitMapChangeDelegate  ,
const FString &  ,
const FString &   
)

Delegate called before a map change at runtime