UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UOnlineEngineInterface Class Reference

#include <OnlineEngineInterface.h>

+ Inheritance diagram for UOnlineEngineInterface:

Classes

struct  FShowWebUrlParams
 

Public Member Functions

virtual bool IsLoaded (FName OnlineIdentifier=NAME_None)
 
virtual FName GetOnlineIdentifier (FWorldContext &WorldContext)
 
virtual bool DoesInstanceExist (FName OnlineIdentifier)
 
virtual void ShutdownOnlineSubsystem (FName OnlineIdentifier)
 
virtual void DestroyOnlineSubsystem (FName OnlineIdentifier)
 
virtual FName GetDefaultOnlineSubsystemName () const
 
virtual bool IsCompatibleUniqueNetId (const FUniqueNetIdWrapper &InUniqueNetId) const
 
virtual uint8 GetReplicationHashForSubsystem (FName InSubsystemName) const
 
virtual FName GetSubsystemFromReplicationHash (uint8 InHash) const
 
virtual FUniqueNetIdWrapper CreateUniquePlayerIdWrapper (const FString &Str, FName Type=NAME_None)
 
virtual FUniqueNetIdWrapper GetUniquePlayerIdWrapper (UWorld *World, int32 LocalUserNum, FName Type=NAME_None)
 
virtual FString GetPlayerNickname (UWorld *World, const FUniqueNetIdWrapper &UniqueId)
 
virtual bool GetPlayerPlatformNickname (UWorld *World, int32 LocalUserNum, FString &OutNickname)
 
virtual bool AutoLogin (UWorld *World, int32 LocalUserNum, const FOnlineAutoLoginComplete &InCompletionDelegate)
 
virtual bool IsLoggedIn (UWorld *World, int32 LocalUserNum)
 
virtual void StartSession (UWorld *World, FName SessionName, FOnlineSessionStartComplete &InCompletionDelegate)
 
virtual void EndSession (UWorld *World, FName SessionName, FOnlineSessionEndComplete &InCompletionDelegate)
 
virtual bool DoesSessionExist (UWorld *World, FName SessionName)
 
virtual bool GetSessionJoinability (UWorld *World, FName SessionName, FJoinabilitySettings &OutSettings)
 
virtual void UpdateSessionJoinability (UWorld *World, FName SessionName, bool bPublicSearchable, bool bAllowInvites, bool bJoinViaPresence, bool bJoinViaPresenceFriendsOnly)
 
virtual void RegisterPlayer (UWorld *World, FName SessionName, const FUniqueNetIdWrapper &UniqueId, bool bWasInvited)
 
virtual void UnregisterPlayer (UWorld *World, FName SessionName, const FUniqueNetIdWrapper &UniqueId)
 
virtual void UnregisterPlayers (UWorld *World, FName SessionName, const TArray< FUniqueNetIdWrapper > &Players)
 
virtual bool GetResolvedConnectString (UWorld *World, FName SessionName, FString &URL)
 
virtual TSharedPtr< FVoicePacketGetLocalPacket (UWorld *World, uint8 LocalUserNum)
 
virtual TSharedPtr< FVoicePacketSerializeRemotePacket (UWorld *World, const UNetConnection *const RemoteConnection, FArchive &Ar)
 
virtual void StartNetworkedVoice (UWorld *World, uint8 LocalUserNum)
 
virtual void StopNetworkedVoice (UWorld *World, uint8 LocalUserNum)
 
virtual void ClearVoicePackets (UWorld *World)
 
virtual bool MuteRemoteTalker (UWorld *World, uint8 LocalUserNum, const FUniqueNetIdWrapper &PlayerId, bool bIsSystemWide)
 
virtual bool UnmuteRemoteTalker (UWorld *World, uint8 LocalUserNum, const FUniqueNetIdWrapper &PlayerId, bool bIsSystemWide)
 
virtual int32 GetNumLocalTalkers (UWorld *World)
 
virtual void ShowLeaderboardUI (UWorld *World, const FString &CategoryName)
 
virtual void ShowAchievementsUI (UWorld *World, int32 LocalUserNum)
 
virtual void BindToExternalUIOpening (const FOnlineExternalUIChanged &Delegate)
 
virtual void ShowWebURL (const FString &CurrentURL, const FShowWebUrlParams &ShowParams, const FOnlineShowWebUrlClosed &CompletionDelegate)
 
virtual bool CloseWebURL ()
 
virtual void DumpSessionState (UWorld *World)
 
virtual void DumpPartyState (UWorld *World)
 
virtual void DumpVoiceState (UWorld *World)
 
virtual void DumpChatState (UWorld *World)
 
virtual bool SupportsOnlinePIE ()
 
virtual void SetShouldTryOnlinePIE (bool bShouldTry)
 
virtual int32 GetNumPIELogins ()
 
virtual FString GetPIELoginCommandLineArgs (int32 Index)
 
virtual void SetForceDedicated (FName OnlineIdentifier, bool bForce)
 
virtual void LoginPIEInstance (FName OnlineIdentifier, int32 LocalUserNum, int32 PIELoginNum, FOnPIELoginComplete &CompletionDelegate)
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Static Public Member Functions

static ENGINE_API UOnlineEngineInterfaceGet ()
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Detailed Description

Interface class between engine and OnlineSubsystem to remove dependencies between the two The real work is implemented in UOnlineEngineInterfaceImpl in OnlineSubsystemUtils The expectation is that this basic group of functions will not expand/change and that OnlineSubsystem can remain independent of the engine

Games should not use this interface, use the OnlineSubsystem plugins directly

Better functionality descriptions can be found in the OnlineSubsystem interfaces

Adding code here is discouraged, there is probably a better way, talk to the OGS team

Member Function Documentation

◆ AutoLogin()

virtual bool UOnlineEngineInterface::AutoLogin ( UWorld World,
int32  LocalUserNum,
const FOnlineAutoLoginComplete InCompletionDelegate 
)
inlinevirtual

Auto login a given player based on credentials specified on the command line

◆ BindToExternalUIOpening()

virtual void UOnlineEngineInterface::BindToExternalUIOpening ( const FOnlineExternalUIChanged Delegate)
inlinevirtual

Bind a delegate to the opening/closing of an online platform's external UI

◆ ClearVoicePackets()

virtual void UOnlineEngineInterface::ClearVoicePackets ( UWorld World)
inlinevirtual

Clears all voice packets currently queued for send

◆ CloseWebURL()

virtual bool UOnlineEngineInterface::CloseWebURL ( )
inlinevirtual

Closes the currently active web external UI

◆ CreateUniquePlayerIdWrapper()

virtual FUniqueNetIdWrapper UOnlineEngineInterface::CreateUniquePlayerIdWrapper ( const FString &  Str,
FName  Type = NAME_None 
)
inlinevirtual

Identity

Returns
a proper FUniqueNetId pointer generated by the default OnlineSubsystem

◆ DestroyOnlineSubsystem()

virtual void UOnlineEngineInterface::DestroyOnlineSubsystem ( FName  OnlineIdentifier)
inlinevirtual

Destroy a given online subsystem

◆ DoesInstanceExist()

virtual bool UOnlineEngineInterface::DoesInstanceExist ( FName  OnlineIdentifier)
inlinevirtual
Returns
true if a given OnlineSubsystem instance exists

◆ DoesSessionExist()

virtual bool UOnlineEngineInterface::DoesSessionExist ( UWorld World,
FName  SessionName 
)
inlinevirtual
Returns
true if a given session exists, false otherwise

◆ DumpChatState()

virtual void UOnlineEngineInterface::DumpChatState ( UWorld World)
inlinevirtual

Dump chat state to the log

◆ DumpPartyState()

virtual void UOnlineEngineInterface::DumpPartyState ( UWorld World)
inlinevirtual

Dump party state to the log

◆ DumpSessionState()

virtual void UOnlineEngineInterface::DumpSessionState ( UWorld World)
inlinevirtual

Debug Dump session state to the log

◆ DumpVoiceState()

virtual void UOnlineEngineInterface::DumpVoiceState ( UWorld World)
inlinevirtual

Dump voice state to the log

◆ EndSession()

virtual void UOnlineEngineInterface::EndSession ( UWorld World,
FName  SessionName,
FOnlineSessionEndComplete InCompletionDelegate 
)
inlinevirtual

End a given named online session

◆ Get()

UOnlineEngineInterface * UOnlineEngineInterface::Get ( )
static
Returns
the singleton accessor of the engine / OnlineSubsystem interface

◆ GetDefaultOnlineSubsystemName()

virtual FName UOnlineEngineInterface::GetDefaultOnlineSubsystemName ( ) const
inlinevirtual

Returns the name of the default online subsystem, generally the DefaultPlatformService config value.

◆ GetLocalPacket()

virtual TSharedPtr< FVoicePacket > UOnlineEngineInterface::GetLocalPacket ( UWorld World,
uint8  LocalUserNum 
)
inlinevirtual

Voice

Returns
any ready generated voice packet for a given local user

◆ GetNumLocalTalkers()

virtual int32 UOnlineEngineInterface::GetNumLocalTalkers ( UWorld World)
inlinevirtual
Returns
number of available/registered local talkers

◆ GetNumPIELogins()

virtual int32 UOnlineEngineInterface::GetNumPIELogins ( )
inlinevirtual
Returns
number of logins stored with the editor for logging in via Play In Editor (PIE)

◆ GetOnlineIdentifier()

virtual FName UOnlineEngineInterface::GetOnlineIdentifier ( FWorldContext WorldContext)
inlinevirtual
Returns
the online identifier that should be used to access the OnlineSubsystem for this context

◆ GetPIELoginCommandLineArgs()

virtual FString UOnlineEngineInterface::GetPIELoginCommandLineArgs ( int32  Index)
inlinevirtual
Returns
a string with all three components (type, id, token) for the login with the given index for logging in via Play in Editor (PIE)

◆ GetPlayerNickname()

virtual FString UOnlineEngineInterface::GetPlayerNickname ( UWorld World,
const FUniqueNetIdWrapper UniqueId 
)
inlinevirtual
Returns
the stored nickname on the OnlineSubsystem for a player with a given unique id

◆ GetPlayerPlatformNickname()

virtual bool UOnlineEngineInterface::GetPlayerPlatformNickname ( UWorld World,
int32  LocalUserNum,
FString &  OutNickname 
)
inlinevirtual
Returns
the stored nickname on the secondary/console OnlineSubsystem for a player with a given unique id

◆ GetReplicationHashForSubsystem()

virtual uint8 UOnlineEngineInterface::GetReplicationHashForSubsystem ( FName  InSubsystemName) const
inlinevirtual

Utils Return the replication hash for a given subsystem

Parameters
InSubsystemNamename of subsystem to retrieve hash from
Returns
replication hash, or 0 if invalid/unknown

◆ GetResolvedConnectString()

virtual bool UOnlineEngineInterface::GetResolvedConnectString ( UWorld World,
FName  SessionName,
FString &  URL 
)
inlinevirtual
Returns
true if there is a valid URL that can been used to connect to a given session, false otherwise

◆ GetSessionJoinability()

virtual bool UOnlineEngineInterface::GetSessionJoinability ( UWorld World,
FName  SessionName,
FJoinabilitySettings OutSettings 
)
inlinevirtual

◆ GetSubsystemFromReplicationHash()

virtual FName UOnlineEngineInterface::GetSubsystemFromReplicationHash ( uint8  InHash) const
inlinevirtual

Return the name of the online subsystem associated with this hash

Parameters
InHashreplication hash for an online subsystem
Returns
name of subsystem this hash belongs to

◆ GetUniquePlayerIdWrapper()

virtual FUniqueNetIdWrapper UOnlineEngineInterface::GetUniquePlayerIdWrapper ( UWorld World,
int32  LocalUserNum,
FName  Type = NAME_None 
)
inlinevirtual
Returns
the unique id for a given local user on the given OnlineSubsystem

◆ IsCompatibleUniqueNetId()

virtual bool UOnlineEngineInterface::IsCompatibleUniqueNetId ( const FUniqueNetIdWrapper InUniqueNetId) const
inlinevirtual

Returns whether the unique net id is compatible

◆ IsLoaded()

virtual bool UOnlineEngineInterface::IsLoaded ( FName  OnlineIdentifier = NAME_None)
inlinevirtual

Subsystem

Returns
true if the online subsystem is loaded, false otherwise

◆ IsLoggedIn()

virtual bool UOnlineEngineInterface::IsLoggedIn ( UWorld World,
int32  LocalUserNum 
)
inlinevirtual
Returns
true if a local user is logged in, false otherwise

◆ LoginPIEInstance()

virtual void UOnlineEngineInterface::LoginPIEInstance ( FName  OnlineIdentifier,
int32  LocalUserNum,
int32  PIELoginNum,
FOnPIELoginComplete CompletionDelegate 
)
inlinevirtual

Login a local user to the online subsystem before starting a Play In Editor (PIE) instance, using credentials stored in the editor

◆ MuteRemoteTalker()

virtual bool UOnlineEngineInterface::MuteRemoteTalker ( UWorld World,
uint8  LocalUserNum,
const FUniqueNetIdWrapper PlayerId,
bool  bIsSystemWide 
)
inlinevirtual

Mute a remote user for a given local player

◆ RegisterPlayer()

virtual void UOnlineEngineInterface::RegisterPlayer ( UWorld World,
FName  SessionName,
const FUniqueNetIdWrapper UniqueId,
bool  bWasInvited 
)
inlinevirtual

Register a given player with the online session

◆ SerializeRemotePacket()

virtual TSharedPtr< FVoicePacket > UOnlineEngineInterface::SerializeRemotePacket ( UWorld World,
const UNetConnection *const  RemoteConnection,
FArchive Ar 
)
inlinevirtual
Returns
a valid voice packet submitted over network

◆ SetForceDedicated()

virtual void UOnlineEngineInterface::SetForceDedicated ( FName  OnlineIdentifier,
bool  bForce 
)
inlinevirtual

Force the online subsystem to treat itself like a dedicated server

◆ SetShouldTryOnlinePIE()

virtual void UOnlineEngineInterface::SetShouldTryOnlinePIE ( bool  bShouldTry)
inlinevirtual

Enable/Disable online PIE at runtime

◆ ShowAchievementsUI()

virtual void UOnlineEngineInterface::ShowAchievementsUI ( UWorld World,
int32  LocalUserNum 
)
inlinevirtual

Show an online external achievements UI if applicable to the platform

◆ ShowLeaderboardUI()

virtual void UOnlineEngineInterface::ShowLeaderboardUI ( UWorld World,
const FString &  CategoryName 
)
inlinevirtual

Show an online external leaderboard UI if applicable to the platform

◆ ShowWebURL()

virtual void UOnlineEngineInterface::ShowWebURL ( const FString &  CurrentURL,
const FShowWebUrlParams ShowParams,
const FOnlineShowWebUrlClosed CompletionDelegate 
)
inlinevirtual

Displays a web page in the external UI

◆ ShutdownOnlineSubsystem()

virtual void UOnlineEngineInterface::ShutdownOnlineSubsystem ( FName  OnlineIdentifier)
inlinevirtual

Shut down a given online subsystem

◆ StartNetworkedVoice()

virtual void UOnlineEngineInterface::StartNetworkedVoice ( UWorld World,
uint8  LocalUserNum 
)
inlinevirtual

Start processing networked voice traffic for a given local user

◆ StartSession()

virtual void UOnlineEngineInterface::StartSession ( UWorld World,
FName  SessionName,
FOnlineSessionStartComplete InCompletionDelegate 
)
inlinevirtual

Session Start a given named online session

◆ StopNetworkedVoice()

virtual void UOnlineEngineInterface::StopNetworkedVoice ( UWorld World,
uint8  LocalUserNum 
)
inlinevirtual

Stop processing networked voice traffic for a given local user

◆ SupportsOnlinePIE()

virtual bool UOnlineEngineInterface::SupportsOnlinePIE ( )
inlinevirtual

PIE Utilities

Returns
true if the online subsystem supports online Play In Editor (PIE)

◆ UnmuteRemoteTalker()

virtual bool UOnlineEngineInterface::UnmuteRemoteTalker ( UWorld World,
uint8  LocalUserNum,
const FUniqueNetIdWrapper PlayerId,
bool  bIsSystemWide 
)
inlinevirtual

UnMute a remote user for a given local player

◆ UnregisterPlayer()

virtual void UOnlineEngineInterface::UnregisterPlayer ( UWorld World,
FName  SessionName,
const FUniqueNetIdWrapper UniqueId 
)
inlinevirtual

Unregister a given player from the online session

◆ UnregisterPlayers()

virtual void UOnlineEngineInterface::UnregisterPlayers ( UWorld World,
FName  SessionName,
const TArray< FUniqueNetIdWrapper > &  Players 
)
inlinevirtual

Unregister a given player from the online session

◆ UpdateSessionJoinability()

virtual void UOnlineEngineInterface::UpdateSessionJoinability ( UWorld World,
FName  SessionName,
bool  bPublicSearchable,
bool  bAllowInvites,
bool  bJoinViaPresence,
bool  bJoinViaPresenceFriendsOnly 
)
inlinevirtual

The documentation for this class was generated from the following files: