Navigation
| Name | CoreOnline |
| Type | Runtime |
| Location | /Engine/Source/Runtime/CoreOnline/ |
| Module Build Rules | CoreOnline.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FOnlineIdRegistryRegistry | |
| FUniqueNetId | Abstraction of a profile service online Id The class is meant to be opaque |
| TNestedVariant | Convenience class to declare all nested types at once. |
| TNestedVariantArray | Classes for working with nested TVariants that also have TArray and TMap references holding TVariants of the same types. |
| TNestedVariantMap | Nested TVariantMap that can hold all provided types plus nested array and map references. |
| TOnlineId | A handle to an id which uniquely identifies a persistent or transient online resource, i.e. account/session/party etc, within a given Online Services provider. |
| TVariantArray | This set of classes enables building nested TVariant structures using shared pointers to TArrays and TMaps. |
| TVariantMap | TMap that holds a TVariant with helper functions for working with variant types. |
Structs
| Name | Remarks |
|---|---|
| FAccount | |
| FJoinabilitySettings | |
| FJsonSerializerPolicy_NestedVariant | |
| FLobby | |
| FLoginContinuation | |
| FSession | |
| FSessionInvite | |
| FUniqueNetIdKeyFuncs | |
| FUniqueNetIdWrapper | |
| FVerifiedAuthSession | |
| FVerifiedAuthTicket | |
| TRecursionScope | Recursion protection for nested composites. |
| TUniqueNetIdMapKeyFuncs |
Interfaces
| Name | Remarks |
|---|---|
| IOnlineIdRegistry |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAccountId | TOnlineId< OnlineIdHandleTags::FAccount > | Online/CoreOnline.h | |
| FDualType | TPair< const void *, const void * > | Dual void* methods for use with Array and Map operator==. | Online/NestedVariant.h |
| FDualVisit | TGuardType< FDualType > | Online/NestedVariant.h | |
| FLobbyId | TOnlineId< OnlineIdHandleTags::FLobby > | Online/CoreOnline.h | |
| FLoginContinuationId | TOnlineId< OnlineIdHandleTags::FLoginContinuation > | Online/CoreOnline.h | |
| FNestedVariantJson | TNestedVariant< FString, bool, int64, double, FString > | Online/NestedVariantJson.h | |
| FNestedVariantValue | TVariant< ValueTypes..., TNestedVariantArrayRef< KeyType, ValueTypes... >, TNestedVariantMapRef< KeyType, ValueTypes... > > | Online/NestedVariant.h | |
| FOnlineSessionId | TOnlineId< OnlineIdHandleTags::FSession > | TODO rename to FSessionId. | Online/CoreOnline.h |
| FSessionInviteId | TOnlineId< OnlineIdHandleTags::FSessionInvite > | Online/CoreOnline.h | |
| FSingleType | const void * | Single void* methods for use with AppendArray and AppendMap. | Online/NestedVariant.h |
| FSingleVisit | TGuardType< FSingleType > | Online/NestedVariant.h | |
| FUniqueNetIdPtr | TSharedPtr< const FUniqueNetId > | Online/CoreOnlineFwd.h | |
| FUniqueNetIdRef | TSharedRef< const FUniqueNetId > | Online/CoreOnlineFwd.h | |
| FUniqueNetIdSet | TSet< FUniqueNetIdRef, FUniqueNetIdKeyFuncs > | Online/CoreOnline.h | |
| FUniqueNetIdWeakPtr | TWeakPtr< const FUniqueNetId > | Online/CoreOnlineFwd.h | |
| FVerifiedAuthSessionId | TOnlineId< OnlineIdHandleTags::FVerifiedAuthSession > | Online/CoreOnline.h | |
| FVerifiedAuthTicketId | TOnlineId< OnlineIdHandleTags::FVerifiedAuthTicket > | Online/CoreOnline.h | |
| IOnlineAccountIdRegistry | IOnlineIdRegistry< OnlineIdHandleTags::FAccount > | Online/CoreOnline.h | |
| IOnlineSessionIdRegistry | IOnlineIdRegistry< OnlineIdHandleTags::FSession > | Online/CoreOnline.h | |
| IOnlineSessionInviteIdRegistry | IOnlineIdRegistry< OnlineIdHandleTags::FSessionInvite > | Online/CoreOnline.h | |
| TGuardType | TSet< VisitType > | Online/NestedVariant.h | |
| TNestedVariantArrayPtr | TSharedPtr< TNestedVariantArray< KeyType, ValueTypes... > > | Online/NestedVariant.h | |
| TNestedVariantArrayRef | TSharedRef< TNestedVariantArray< KeyType, ValueTypes... > > | Online/NestedVariant.h | |
| TNestedVariantMapPtr | TSharedPtr< TNestedVariantMap< KeyType, ValueTypes... > > | Online/NestedVariant.h | |
| TNestedVariantMapRef | TSharedRef< TNestedVariantMap< KeyType, ValueTypes... > > | Online/NestedVariant.h | |
| TUniqueNetIdMap | TMap< FUniqueNetIdRef, ValueType, FDefaultSetAllocator, TUniqueNetIdMapKeyFuncs< ValueType > > | Online/CoreOnline.h |
Enums
Public
| Name | Remarks |
|---|---|
| UE::Online::EOnlineServices |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void LexFromString
(
FNestedVariantJson::FMap& OutValue, |
Online/NestedVariantJson.h | ||
void NestedVariantFromJson
(
const char* InJson, |
Online/NestedVariantJson.h | ||
void NestedVariantFromJsonObject
(
const TSharedPtr< FJsonObject >& JsonObject, |
Online/NestedVariantJson.h | ||
FString NestedVariantToJson
(
const FNestedVariantJson::FMapPtr& Map |
Online/NestedVariantJson.h | ||
TSharedRef< FJsonObject > NestedVariantToJsonObject
(
const FNestedVariantJson::FMapRef& Map |
Online/NestedVariantJson.h | ||
uint32 UE::Online::GetTypeHash
(
const TOnlineId< IdType >& OnlineId |
Online/CoreOnline.h | ||
void UE::Online::NestedVariant::AppendArray
(
const TNestedVariantArray< KeyType, ValueTypes... >& Array, |
Forward declarations used in AppendVariant. | Online/NestedVariant.h | |
void UE::Online::NestedVariant::AppendIndent
(
FString& OutString, |
String appending methods for use with ToDebugString(). | Online/NestedVariant.h | |
void UE::Online::NestedVariant::AppendMap
(
const TNestedVariantMap< KeyType, ValueTypes... >& Map, |
Online/NestedVariant.h | ||
void UE::Online::NestedVariant::AppendValue
(
FString& OutString, |
Online/NestedVariant.h | ||
void UE::Online::NestedVariant::AppendValue
(
FString& OutString, |
Online/NestedVariant.h | ||
void UE::Online::NestedVariant::AppendValue
(
FString& OutString, |
Online/NestedVariant.h | ||
void UE::Online::NestedVariant::AppendVariant
(
const FNestedVariantValue< KeyType, ValueTypes... >& Variant, |
Online/NestedVariant.h | ||
bool UE::Online::NestedVariant::Compare
(
const T& Lhs, |
Comparison functions for use with operator==. | Online/NestedVariant.h | |
bool UE::Online::NestedVariant::Compare
(
const TNestedVariantArray< KeyType, ValueTypes... >& Lhs, |
TNestedVariantArray comparison. | Online/NestedVariant.h | |
bool UE::Online::NestedVariant::Compare
(
const TNestedVariantArrayRef< KeyType, ValueTypes... >& Lhs, |
Dereference TNestedVariantArrayRef to TNestedVariantArray. | Online/NestedVariant.h | |
bool UE::Online::NestedVariant::Compare
(
const TNestedVariantMap< KeyType, ValueTypes... >& Lhs, |
TNestedVariantMap comparison. | Online/NestedVariant.h | |
bool UE::Online::NestedVariant::Compare
(
const TNestedVariantMapRef< KeyType, ValueTypes... >& Lhs, |
Dereference TNestedVariantMapRef to TNestedVariantMap. | Online/NestedVariant.h | |
bool UE::Online::NestedVariant::CompareVariants
(
const FNestedVariantValue< KeyType, ValueTypes... >& Lhs, |
Forward declaration for use in various Compare functions. | Online/NestedVariant.h | |
bool UE::Online::NestedVariant::ContainsID
(
const FSingleVisit& VisitSet, |
Online/NestedVariant.h | ||
bool UE::Online::NestedVariant::ContainsID
(
const FDualVisit& VisitSet, |
Online/NestedVariant.h | ||
FSingleType UE::Online::NestedVariant::MakeID
(
const void* InID |
Online/NestedVariant.h | ||
FDualType UE::Online::NestedVariant::MakeID
(
const void* Left, |
Online/NestedVariant.h | ||
FString UE::Online::NestedVariant::ToString
(
FSingleType InID |
Online/NestedVariant.h | ||
FString UE::Online::NestedVariant::ToString
(
FDualType InPair |
Online/NestedVariant.h |