UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Online Namespace Reference

Namespaces

namespace  NestedVariant
 
namespace  OnlineIdHandleTags
 

Classes

class  FOnlineForeignAccountIdRegistry
 
class  FOnlineIdRegistryRegistry
 
class  IOnlineIdRegistry
 
class  TOnlineId
 

Typedefs

using FAccountId = TOnlineId< OnlineIdHandleTags::FAccount >
 
using FLobbyId = TOnlineId< OnlineIdHandleTags::FLobby >
 
using FOnlineSessionId = TOnlineId< OnlineIdHandleTags::FSession >
 
using FSessionInviteId = TOnlineId< OnlineIdHandleTags::FSessionInvite >
 
using FVerifiedAuthTicketId = TOnlineId< OnlineIdHandleTags::FVerifiedAuthTicket >
 
using FVerifiedAuthSessionId = TOnlineId< OnlineIdHandleTags::FVerifiedAuthSession >
 
using FLoginContinuationId = TOnlineId< OnlineIdHandleTags::FLoginContinuation >
 
using IOnlineAccountIdRegistry = IOnlineIdRegistry< OnlineIdHandleTags::FAccount >
 
using IOnlineSessionIdRegistry = IOnlineIdRegistry< OnlineIdHandleTags::FSession >
 
using IOnlineSessionInviteIdRegistry = IOnlineIdRegistry< OnlineIdHandleTags::FSessionInvite >
 

Enumerations

enum class  EOnlineServices : uint8 {
  Null , Epic , Xbox , PSN ,
  Nintendo , Reserved_5 , Steam , Google ,
  GooglePlay , Apple , AppleGameKit , Samsung ,
  Oculus , Tencent , EpicAccount , EpicGame ,
  Reserved_16 , Reserved_17 , Reserved_18 , Reserved_19 ,
  Reserved_20 , Reserved_21 , Reserved_22 , Reserved_23 ,
  Reserved_24 , Reserved_25 , Reserved_26 , Reserved_27 ,
  GameDefined_0 = 28 , GameDefined_1 , GameDefined_2 , GameDefined_3 ,
  None = 253 , Platform = 254 , Default = 255
}
 

Functions

void RegisterAliasForGameDefined (EOnlineServices Value, const TCHAR *InStr)
 
const TCHARLexToString (EOnlineServices Value)
 
void LexFromString (EOnlineServices &OutValue, const TCHAR *InStr)
 
bool TEMP_ShouldUseEpicModularPlugins ()
 
template<typename IdType >
FString ToStringImpl (const IdType &Id)
 
FString ToString (const FAccountId &Id)
 
template<typename IdType >
FString ToLogStringImpl (const IdType &Id)
 
FString ToLogString (const FAccountId &Id)
 
template<typename IdType >
uint32 GetTypeHash (const TOnlineId< IdType > &OnlineId)
 

Variables

TCHAR OnlineServicesAliasArray [OnlineServicesAliasArraySize][UE_ONLINE_ONLINESERVICES_MAX_LENGTH] = {}
 

Typedef Documentation

◆ FAccountId

◆ FLobbyId

◆ FLoginContinuationId

◆ FOnlineSessionId

◆ FSessionInviteId

◆ FVerifiedAuthSessionId

◆ FVerifiedAuthTicketId

◆ IOnlineAccountIdRegistry

◆ IOnlineSessionIdRegistry

◆ IOnlineSessionInviteIdRegistry

Enumeration Type Documentation

◆ EOnlineServices

Enumerator
Null 
Epic 
Xbox 
PSN 
Nintendo 
Reserved_5 
Steam 
Google 
GooglePlay 
Apple 
AppleGameKit 
Samsung 
Oculus 
Tencent 
EpicAccount 
EpicGame 
Reserved_16 
Reserved_17 
Reserved_18 
Reserved_19 
Reserved_20 
Reserved_21 
Reserved_22 
Reserved_23 
Reserved_24 
Reserved_25 
Reserved_26 
Reserved_27 
GameDefined_0 
GameDefined_1 
GameDefined_2 
GameDefined_3 
None 
Platform 
Default 

Function Documentation

◆ GetTypeHash()

template<typename IdType >
uint32 UE::Online::GetTypeHash ( const TOnlineId< IdType > &  OnlineId)
inline

◆ LexFromString()

COREONLINE_API void UE::Online::LexFromString ( EOnlineServices OutValue,
const TCHAR InStr 
)

◆ LexToString()

COREONLINE_API const TCHAR * UE::Online::LexToString ( EOnlineServices  Value)

◆ RegisterAliasForGameDefined()

COREONLINE_API void UE::Online::RegisterAliasForGameDefined ( EOnlineServices  Value,
const TCHAR InStr 
)

◆ TEMP_ShouldUseEpicModularPlugins()

COREONLINE_API bool UE::Online::TEMP_ShouldUseEpicModularPlugins ( )

Temporary Signals that the EOnlineServices::Epic monolithic plugins should not be used, and EOnlineServices::EpicAccount/EpicGame should be used instead. This is a stepping stone to promoting the EOnlineServices::EpicAccount/EpicGame modular plugins and deprecating the monolithic ones.

◆ ToLogString()

COREONLINE_API FString UE::Online::ToLogString ( const FAccountId Id)

◆ ToLogStringImpl()

template<typename IdType >
FString UE::Online::ToLogStringImpl ( const IdType &  Id)

◆ ToString()

COREONLINE_API FString UE::Online::ToString ( const FAccountId Id)

◆ ToStringImpl()

template<typename IdType >
FString UE::Online::ToStringImpl ( const IdType &  Id)

Variable Documentation

◆ OnlineServicesAliasArray

TCHAR UE::Online::OnlineServicesAliasArray[OnlineServicesAliasArraySize][UE_ONLINE_ONLINESERVICES_MAX_LENGTH] = {}