OnlineSubsystemUtils

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

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

Enums

	Name	Description
	EAddressResolutionState	A state system of the address resolution functionality.
	EBeaconConnectionState	State of a connection.
	EBeaconState::Type	States that a beacon can be in
	EClientRequestType	Types of reservation requests that can be made by this beacon
	EInAppPurchaseStatus	State of a purchase transaction
	EOnlineProxyStoreOfferDiscountType	Copyright Epic Games, Inc. All Rights Reserved.
	EPartyReservationResult::Type	The result code that will be returned during party reservation
	ESpectatorClientRequestType	Types of reservation requests that can be made by this beacon
	ESpectatorReservationResult::Type	The result code that will be returned during spectator reservation
	EVoipStreamDataFormat

Functions

	Name	Description
FText	EPartyReservationResult::GetDisplayString ( EPartyReservationResult::Type Respo... )
const TCHAR ...	EPartyReservationResult::ToString ( EPartyReservationResult::Type Sessi... )
FText	ESpectatorReservationResult::GetDisplayString ( ESpectatorReservationResult::Type R... )
const TCHAR ...	ESpectatorReservationResult::ToString ( ESpectatorReservationResult::Type S... )
bool	Online::DoesInstanceExist ( const UWorld* World, const FName& SubsystemName )	Determine if the subsystem for a given interface has been instanced
IOnlineAchie...	Online::GetAchievementsInterface ( const UWorld* World, const FName SubsystemName )
IOnlineAchie...	Online::GetAchievementsInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineChatP...	Online::GetChatInterface ( const UWorld* World, const FName SubsystemName )
IOnlineChatP...	Online::GetChatInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineEntit...	Online::GetEntitlementsInterface ( const UWorld* World, const FName SubsystemName )
IOnlineEntit...	Online::GetEntitlementsInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineEvent...	Online::GetEventsInterface ( const UWorld* World, const FName SubsystemName )
IOnlineEvent...	Online::GetEventsInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineExter...	Online::GetExternalUIInterface ( const UWorld* World, const FName SubsystemName )
IOnlineExter...	Online::GetExternalUIInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineFrien...	Online::GetFriendsInterface ( const UWorld* World, const FName SubsystemName )
IOnlineFrien...	Online::GetFriendsInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineIdent...	Online::GetIdentityInterface ( const UWorld* World, const FName SubsystemName )
IOnlineIdent...	Online::GetIdentityInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineLeade...	Online::GetLeaderboardsInterface ( const UWorld* World, const FName SubsystemName )
IOnlineLeade...	Online::GetLeaderboardsInterfaceChecked ( const UWorld* World, const FName SubsystemName )
TModularFeat...	Online::GetModularFeature ( const FName Type )	Wrapper for IModularFeatures::IsModularFeatureAvailable and IModularFeatures::GetModularFeature
IOnlineParty...	Online::GetPartyInterface ( const UWorld* World, const FName SubsystemName )
IOnlineParty...	Online::GetPartyInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlinePrese...	Online::GetPresenceInterface ( const UWorld* World, const FName SubsystemName )
IOnlinePrese...	Online::GetPresenceInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlinePurch...	Online::GetPurchaseInterface ( const UWorld* World, const FName SubsystemName )
IOnlinePurch...	Online::GetPurchaseInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineSessi...	Online::GetSessionInterface ( const UWorld* World, const FName SubsystemName )	Reimplement all the interfaces of Online.h with support for UWorld accessors
IOnlineSessi...	Online::GetSessionInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineShare...	Online::GetSharedCloudInterface ( const UWorld* World, const FName SubsystemName )
IOnlineShare...	Online::GetSharedCloudInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineStats...	Online::GetStatsInterface ( const UWorld* World, const FName SubsystemName )
IOnlineStats...	Online::GetStatsInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineSubsy...	Online::GetSubsystem ( const UWorld* World, const FName& SubsystemName )	Get the online subsystem for a given service
IOnlineTimeP...	Online::GetTimeInterface ( const UWorld* World, const FName SubsystemName )
IOnlineTimeP...	Online::GetTimeInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineTitle...	Online::GetTitleFileInterface ( const UWorld* World, const FName SubsystemName )
IOnlineTitle...	Online::GetTitleFileInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineUserC...	Online::GetUserCloudInterface ( const UWorld* World, const FName SubsystemName )
IOnlineUserC...	Online::GetUserCloudInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineUserP...	Online::GetUserInterface ( const UWorld* World, const FName SubsystemName )
IOnlineUserP...	Online::GetUserInterfaceChecked ( const UWorld* World, const FName SubsystemName )
IOnlineSubsy...	Online::GetUtils()
IOnlineVoice...	Online::GetVoiceInterface ( const UWorld* World, const FName SubsystemName )
IOnlineVoice...	Online::GetVoiceInterfaceChecked ( const UWorld* World, const FName SubsystemName )
bool	Online::IsLoaded ( const UWorld* World, const FName& SubsystemName )	Determine if the subsystem module for a given interface is already loaded.
const TCHAR ...	ToString ( EBeaconConnectionState Value )
const TCHAR ...	ToString ( EClientRequestType RequestType )
const TCHAR ...	ToString ( ESpectatorClientRequestType Request... )

Variables

		Name	Description
	TSharedPtr< FIn...	GCurrentDuplicateIP	CVars.