Navigation
| Name | OnlineSubsystemUtils |
| Type | Plugin |
| Part of Plugins | Online Subsystem Utils |
| Location | /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/ |
| Module Build Rules | OnlineSubsystemUtils.Build.cs |
Classes
| Name | Remarks |
|---|---|
| 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 |
| FAchievementWriteCompleteDelegate | |
| FAchievementWriteDelegate | |
| FBlueprintFindSessionsResultDelegate | |
| FFindTurnBasedMatchCallbackProxyMatchmakerDelegate | |
| FInAppPurchaseQuery2Result | |
| FInAppPurchaseRestoreResult2 | |
| FInAppPurchaseResult2 | |
| FLeaderboardQueryResult | |
| FOnLeaderboardFlushed | |
| FOnlineConnectionResult | |
| FOnlineLogoutResult | |
| FOnlineProxyInAppCheckoutResult | |
| FOnlineProxyInAppReceiptsResult | |
| 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 |
| FRemoteTalkerDataImpl | Remote voice data playing on a single client |
| FVoiceEndpoint | Small class that manages an audio endpoint. |
| FVoiceEngineImpl | Generic implementation of voice engine, using Voice module for capture/codec |
| FVoicePacketBuffer | FVoicePacketBuffer |
| FVoicePacketImpl | Defines the data involved in a voice packet |
| UAchievementBlueprintLibrary | Library of synchronous achievement calls. |
| UAchievementQueryCallbackProxy | |
| UAchievementWriteCallbackProxy | |
| UConnectionCallbackProxy | |
| UCreateSessionCallbackProxy | |
| UDestroySessionCallbackProxy | |
| UEndMatchCallbackProxy | |
| UEndTurnCallbackProxy | |
| UFindSessionsCallbackProxy | |
| UFindTurnBasedMatchCallbackProxy | |
| UInAppPurchaseCallbackProxy2 | |
| UInAppPurchaseCheckoutCallbackProxy | |
| UInAppPurchaseFinalizeProxy | |
| UInAppPurchaseQueryCallbackProxy2 | |
| UInAppPurchaseReceiptsCallbackProxy | |
| 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 |
Structs
| Name | Remarks |
|---|---|
| FBlueprintSessionResult | |
| FInAppPurchaseProductInfo2 | |
| FInAppPurchaseProductRequest2 | Micro-transaction request information |
| FInAppPurchaseReceiptInfo2 | Micro-transaction purchase information |
| FInAppPurchaseRestoreInfo2 | Micro-transaction purchase information |
| FLocalVoiceData | Container for unprocessed voice data |
| FOnlineAccountStoredCredentials | |
| FOnlineProxyStoreOffer | Offer entry for display from online store |
| FPartyBeaconCrossplayPlatformMapping | Platform mapping for crossplay checks |
| FPartyReservation | A whole party reservation |
| FPlayerReservation | A single player reservation |
| FSortedVoicePacketNode | FSortedVoicePacketNode |
| FSpectatorReservation | A whole Spectator reservation |
| FVoiceAmplitudeData | Container for voice amplitude data |
| FVoiceDataImpl | Holds the current voice packet data state |
Interfaces
| Name | Remarks |
|---|---|
| IOnlineServicesEngineUtils | Interface class for various online utility functions for Engine |
| IOnlineSubsystemUtils | Interface class for various online utility functions |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCancelationReceived | TBaseDelegate_OneParam< void, const FUniqueNetId & > | Delegate fired when a the beacon host has been told to cancel a reservation | SpectatorBeaconHost.h |
| FOnCancelationReceived | TBaseDelegate_OneParam< void, const FUniqueNetId & > | Delegate fired when a the beacon host has been told to cancel a reservation | PartyBeaconHost.h |
| FOnDuplicateReservation | TBaseDelegate_OneParam< void, const FPartyReservation & > | Delegate fired when a the beacon host detects a duplicate reservation | PartyBeaconHost.h |
| FOnExternalUIChange | TMulticastDelegate_OneParam< void, bool > | Online/OnlineServicesEngineUtils.h | |
| FOnHostConnectionFailure | TBaseDelegate_NoParams< void > | Delegate triggered on failures to connect to a host beacon | OnlineBeaconClient.h |
| FOnlineVoiceImplPtr | TSharedPtr< FOnlineVoiceImpl, ESPMode::ThreadSafe > | VoiceInterfaceImpl.h | |
| FOnNewPlayerAdded | TBaseDelegate_OneParam< void, const FPlayerReservation & > | Delegate fired when a the beacon host has added a new player | SpectatorBeaconHost.h |
| FOnNewPlayerAdded | TBaseDelegate_OneParam< void, const FPlayerReservation & > | Delegate fired when a the beacon host has added a new player | PartyBeaconHost.h |
| FOnReservationCountUpdate | TBaseDelegate_OneParam< void, int32 > | Delegate triggered when the host indicated a reservation count has changed | PartyBeaconClient.h |
| FOnReservationCountUpdate | TBaseDelegate_OneParam< void, int32 > | Delegate triggered when the host indicated a reservation count has changed | SpectatorBeaconClient.h |
| FOnReservationFull | TBaseDelegate_NoParams< void > | Delegate triggered when the host indicated the reservation is full | PartyBeaconClient.h |
| FOnReservationFull | TBaseDelegate_NoParams< void > | Delegate triggered when the host indicated the reservation is full | SpectatorBeaconClient.h |
| FOnReservationRequestComplete | TBaseDelegate_OneParam< void, EPartyReservationResult::Type > | Delegate triggered when a response from the party beacon host has been received | PartyBeaconClient.h |
| FOnReservationUpdate | TBaseDelegate_NoParams< void > | Delegate type for handling reservation additions/removals, or full events | PartyBeaconHost.h |
| FOnReservationUpdate | TBaseDelegate_NoParams< void > | Delegate type for handling reservation additions/removals, or full events | SpectatorBeaconHost.h |
| FOnSpectatorDuplicateReservation | TBaseDelegate_OneParam< void, const FSpectatorReservation & > | Delegate fired when a the beacon host detects a duplicate reservation | SpectatorBeaconHost.h |
| FOnSpectatorReservationRequestComplete | TBaseDelegate_OneParam< void, ESpectatorReservationResult::Type > | Delegate triggered when a response from the spectator beacon host has been received | SpectatorBeaconClient.h |
| FOnSpectatorValidatePlayers | TBaseDelegate_OneParam< bool, const FPlayerReservation & > | Delegate called when the beacon gets any request, allowing the owner to validate players at a higher level (bans,etc) | SpectatorBeaconHost.h |
| FOnValidatePlayers | TBaseDelegate_OneParam< bool, const TArray< FPlayerReservation > & > | Delegate called when the beacon gets any request, allowing the owner to validate players at a higher level (bans,etc) | PartyBeaconHost.h |
| FVoiceEngineImplPtr | TSharedPtr< FVoiceEngineImpl, ESPMode::ThreadSafe > | VoiceEngineImpl.h |
Enums
Public
| Name | Remarks |
|---|---|
| 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 |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GCurrentDuplicateIP | TSharedPtr< FInternetAddr > | CVars. | IpNetDriver.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FText EPartyReservationResult::GetDisplayString
(
EPartyReservationResult::Type Response |
PartyBeaconState.h | ||
const TCHAR * EPartyReservationResult::ToString
(
EPartyReservationResult::Type SessionType |
PartyBeaconState.h | ||
FText ESpectatorReservationResult::GetDisplayString
(
ESpectatorReservationResult::Type Response |
SpectatorBeaconState.h | ||
const TCHAR * ESpectatorReservationResult::ToString
(
ESpectatorReservationResult::Type SessionType |
SpectatorBeaconState.h | ||
EInAppPurchaseStatus PurchaseStatusFromOnlineError
(
const FOnlineError& OnlineError |
InAppPurchaseDataTypes.h | ||
const TCHAR * ToString
(
EBeaconConnectionState Value |
OnlineBeaconClient.h | ||
const TCHAR * ToString
(
EClientRequestType RequestType |
PartyBeaconClient.h | ||
const TCHAR * ToString
(
ESpectatorClientRequestType RequestType |
SpectatorBeaconClient.h |