1. Epic GamesDeveloper
  3. OnlineSubsystemUtils

OnlineSubsystemUtils

Unreal Engine C++ API Reference > Plugins

Filters

Classes

  Type Name Description
Public class UClass MinimalAPI NotPlaceable Transient, Config AOnlineBeacon Base class for beacon communication (Unreal Networking, but outside normal gameplay traffic)  
Public class UClass NotPlaceable Transient, Config AOnlineBeaconClient Base class for any unique beacon connectivity, paired with an AOnlineBeaconHostObject implementation  
Public class UClass NotPlaceable Transient, Config AOnlineBeaconHost Main actor that listens for side channel communication from another Unreal Engine application  
Public class UClass NotPlaceable Transient, Config AOnlineBeaconHostObject Base class for any unique beacon connectivity, paired with an AOnlineBeaconClient implementation  
Public class UClass NotPlaceable Transient, Config APartyBeaconClient A beacon client used for making reservations with an existing game session  
Public class UClass NotPlaceable Transient, Config APartyBeaconHost A beacon host used for taking reservations for an existing game session  
Public class UClass NotPlaceable Transient, Config ASpectatorBeaconClient A beacon client used for making reservations with an existing game session  
Public class UClass NotPlaceable Transient, Config ASpectatorBeaconHost A beacon host used for taking reservations for an existing game session  
Public class UClass NotPlaceable Transient, Config ATestBeaconClient A beacon client used for making reservations with an existing game session  
Public class UClass NotPlaceable Transient, Config ATestBeaconHost A beacon host used for taking reservations for an existing game session  
Public class FAchievementWriteDelegate    
Public class FBlueprintFindSessionsResultDelegate    
Public struct UStruct BlueprintType FBlueprintSessionResult    
Public class FFindTurnBasedMatchCallbackProxyMatchmakerDelegate    
Public struct UStruct BlueprintType FInAppPurchaseProductInfo2 Copyright Epic Games, Inc. All Rights Reserved.  
Public struct UStruct BlueprintType FInAppPurchaseProductRequest2 Micro-transaction request information  
Public class FInAppPurchaseQuery2Result    
Public struct UStruct BlueprintType FInAppPurchaseReceiptInfo2 Micro-transaction purchase information  
Public struct UStruct BlueprintType FInAppPurchaseRestoreInfo2 Micro-transaction purchase information  
Public class FInAppPurchaseRestoreResult2    
Public class FInAppPurchaseResult2    
Public class FLeaderboardQueryResult Copyright Epic Games, Inc. All Rights Reserved.  
Public struct FLocalVoiceData Container for unprocessed voice data  
Public class FOnLeaderboardFlushed Copyright Epic Games, Inc. All Rights Reserved.  
Public class FOnlineConnectionResult    
Public class FOnlineLogoutResult    
Public class FOnlineProxyInAppCheckoutResult Copyright Epic Games, Inc. All Rights Reserved.  
Public class FOnlineProxyInAppReceiptsResult Copyright Epic Games, Inc. All Rights Reserved.  
Public struct UStruct BlueprintType FOnlineProxyStoreOffer Offer entry for display from online store  
Public class FOnlineShowLoginUIResult    
Public class FOnlineSubsystemUtilsModule Online subsystem utils module class Misc functionality where dependency on the engine code is allowed (OnlineSubsystem is not allowed to require engine dependencies)  
Public class FOnlineTurnBasedMatchResult    
Public class FOnlineVoiceImpl The generic implementation of the voice interface  
Public struct UStruct FPartyBeaconCrossplayPlatformMapping Platform mapping for crossplay checks  
Public struct UStruct FPartyReservation A whole party reservation  
Public struct UStruct FPlayerReservation A single player reservation  
Public class FRemoteTalkerDataImpl Remote voice data playing on a single client  
Public struct FSortedVoicePacketNode FSortedVoicePacketNode This structure represents an individual packet in the FVoicePacketBuffer.  
Public struct UStruct FSpectatorReservation A whole Spectator reservation  
Public struct FVoiceAmplitudeData Container for voice amplitude data  
Public struct FVoiceDataImpl Holds the current voice packet data state  
Public class FVoiceEndpoint Small class that manages an audio endpoint.  
Public class FVoiceEngineImpl Generic implementation of voice engine, using Voice module for capture/codec  
Public class FVoicePacketBuffer FVoicePacketBuffer This class is used to handle sorting of packets as they arrive.  
Public class FVoicePacketImpl Defines the data involved in a voice packet  
Public class IOnlineSubsystemUtils Interface class for various online utility functions  
Public class UClass Meta UAchievementBlueprintLibrary Library of synchronous achievement calls.  
Public class UClass MinimalAPI UAchievementQueryCallbackProxy    
Public class UClass MinimalAPI UAchievementWriteCallbackProxy    
Public class UClass MinimalAPI UConnectionCallbackProxy    
Public class UClass MinimalAPI UCreateSessionCallbackProxy    
Public class UClass MinimalAPI UDestroySessionCallbackProxy    
Public class UClass MinimalAPI UEndMatchCallbackProxy    
Public class UClass MinimalAPI UEndTurnCallbackProxy    
Public class UClass MinimalAPI UFindSessionsCallbackProxy    
Public class UClass MinimalAPI UFindTurnBasedMatchCallbackProxy    
Public class UClass MinimalAPI UInAppPurchaseCallbackProxy2    
Public class UClass MinimalAPI UInAppPurchaseCheckoutCallbackProxy    
Public class UClass MinimalAPI UInAppPurchaseFinalizeProxy    
Public class UClass MinimalAPI UInAppPurchaseQueryCallbackProxy2    
Public class UClass MinimalAPI UInAppPurchaseReceiptsCallbackProxy    
Public class UClass MinimalAPI UInAppPurchaseRestoreCallbackProxy2    
Public class UClass Transient, Config UIpConnection A state system of the address resolution functionality.  
Public class UClass Transient, Config UIpNetDriver    
Public class UClass MinimalAPI UJoinSessionCallbackProxy    
Public class UClass Meta ULeaderboardBlueprintLibrary A beacon host used for taking reservations for an existing game session  
Public class UClass MinimalAPI ULeaderboardFlushCallbackProxy    
Public class UClass MinimalAPI ULeaderboardQueryCallbackProxy    
Public class UClass MinimalAPI ULogoutCallbackProxy    
Public class UClass Config UOnlineSessionClient    
Public class UClass Transient, Config UPartyBeaconState A beacon host used for taking reservations for an existing game session  
Public class UClass MinimalAPI UQuitMatchCallbackProxy    
Public class UClass MinimalAPI UShowLoginUICallbackProxy    
Public class UClass Transient, Config USpectatorBeaconState A beacon host used for taking reservations for an existing game session  
Public class UClass Meta UTurnBasedBlueprintLibrary Library of synchronous achievement calls.  
Public class UClass UVoipListenerSynthComponent    

Typedefs

Name Description
FOnCancelationReceived Delegate fired when a the beacon host has been told to cancel a reservation
FOnCancelationReceived Delegate fired when a the beacon host has been told to cancel a reservation
FOnDuplicateReservation Delegate fired when a the beacon host detects a duplicate reservation
FOnHostConnectionFailure Delegate triggered on failures to connect to a host beacon
FOnlineVoiceImplPtr  
FOnNewPlayerAdded Delegate fired when a the beacon host has added a new player
FOnNewPlayerAdded Delegate fired when a the beacon host has added a new player
FOnReservationCountUpdate Delegate triggered when the host indicated a reservation count has changed
FOnReservationCountUpdate Delegate triggered when the host indicated a reservation count has changed
FOnReservationFull Delegate triggered when the host indicated the reservation is full
FOnReservationFull Delegate triggered when the host indicated the reservation is full
FOnReservationRequestComplete Delegate triggered when a response from the party beacon host has been received
FOnReservationUpdate Delegate type for handling reservation additions/removals, or full events
FOnReservationUpdate Delegate type for handling reservation additions/removals, or full events
FOnSpectatorDuplicateReservation Delegate fired when a the beacon host detects a duplicate reservation
FOnSpectatorReservationRequestComplete Delegate triggered when a response from the spectator beacon host has been received
FOnSpectatorValidatePlayers Delegate called when the beacon gets any request, allowing the owner to validate players at a higher level (bans,etc)
FOnValidatePlayers Delegate called when the beacon gets any request, allowing the owner to validate players at a higher level (bans,etc)
FSetSocketComplete Callback triggered when setting a new socket has completed (which may not return immediately, due to multithreading)
FVoiceEngineImplPtr  

Enums

  Type Name Description
Public enum UEnum EBeaconConnectionState State of a connection.  
Public enum EBeaconState::Type States that a beacon can be in  
Public enum UEnum EClientRequestType Types of reservation requests that can be made by this beacon  
Public enum UEnum BlueprintType EInAppPurchaseStatus State of a purchase transaction  
Public enum UEnum BlueprintType EOnlineProxyStoreOfferDiscountType Copyright Epic Games, Inc. All Rights Reserved.  
Public enum EPartyReservationResult::Type The result code that will be returned during party reservation  
Public enum UEnum ESpectatorClientRequestType Types of reservation requests that can be made by this beacon  
Public enum ESpectatorReservationResult::Type The result code that will be returned during spectator reservation  
Public enum EVoipStreamDataFormat    
Public enum UE::Net::ERecreateSocketResult Results for UIpNetDriver::RecreateSocket  

Functions

  Type Name Description
Public function FText  
Public function const TCHAR *  
Public function FText  
Public function const TCHAR *  
Public function Static bool

Online::DoesInstanceExist ( const UWorld* World,
const FName& SubsystemName
)

 Determine if the subsystem for a given interface has been instanced
Public function Static IOnlineAchievementsPtr

Online::GetAchievementsInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineAchievementsPtr

Online::GetAchievementsInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineChatPtr

Online::GetChatInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineChatPtr

Online::GetChatInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineEntitlementsPtr

Online::GetEntitlementsInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineEntitlementsPtr

Online::GetEntitlementsInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineEventsPtr

Online::GetEventsInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineEventsPtr

Online::GetEventsInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineExternalUIPtr

Online::GetExternalUIInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineExternalUIPtr

Online::GetExternalUIInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineFriendsPtr

Online::GetFriendsInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineFriendsPtr

Online::GetFriendsInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineIdentityPtr

Online::GetIdentityInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineIdentityPtr

Online::GetIdentityInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineLeaderboardsPtr

Online::GetLeaderboardsInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineLeaderboardsPtr

Online::GetLeaderboardsInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function TModularFeature * Wrapper for IModularFeatures::IsModularFeatureAvailable and IModularFeatures::GetModularFeature
Public function Static IOnlinePartyPtr

Online::GetPartyInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlinePartyPtr

Online::GetPartyInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlinePresencePtr

Online::GetPresenceInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlinePresencePtr

Online::GetPresenceInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlinePurchasePtr

Online::GetPurchaseInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlinePurchasePtr

Online::GetPurchaseInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineSessionPtr

Online::GetSessionInterface ( const UWorld* World,
const FName SubsystemName
)

 Reimplement all the interfaces of Online.h with support for UWorld accessors
Public function Static IOnlineSessionPtr

Online::GetSessionInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineSharedCloudPtr

Online::GetSharedCloudInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineSharedCloudPtr

Online::GetSharedCloudInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineStatsPtr

Online::GetStatsInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineStatsPtr

Online::GetStatsInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineSubsystem *

Online::GetSubsystem ( const UWorld* World,
const FName& SubsystemName
)

 Get the online subsystem for a given service
Public function Static IOnlineTimePtr

Online::GetTimeInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineTimePtr

Online::GetTimeInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineTitleFilePtr

Online::GetTitleFileInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineTitleFilePtr

Online::GetTitleFileInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineUserCloudPtr

Online::GetUserCloudInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineUserCloudPtr

Online::GetUserCloudInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineUserPtr

Online::GetUserInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineUserPtr

Online::GetUserInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineSubsystemUtils *  
Public function Static IOnlineVoicePtr

Online::GetVoiceInterface ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static IOnlineVoicePtr

Online::GetVoiceInterfaceChecked ( const UWorld* World,
const FName SubsystemName
)

  
Public function Static bool

Online::IsLoaded ( const UWorld* World,
const FName& SubsystemName
)

 Determine if the subsystem module for a given interface is already loaded.
Public function EInAppPurchaseStatus  
Public function const TCHAR *  
Public function const TCHAR *

ToString ( EClientRequestType RequestType
)

  
Public function const TCHAR *  
Public function const TCHAR *  

Variables

  Type Name Description
Public variable TSharedPtr< FInternetAddr > GCurrentDuplicateIP CVars.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page