OnlineSubsystemUtils

Windows
MacOS
Linux

Classes

Name

Description

Public class UClass 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

Micro-transaction purchase information

Public struct UStruct BlueprintType

FInAppPurchaseProductRequest2

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FInAppPurchaseQuery2Result

Public class

FInAppPurchaseQueryResult

Copyright Epic Games, Inc. All Rights Reserved.

Public struct UStruct BlueprintType

FInAppPurchaseReceiptInfo

Copyright Epic Games, Inc. All Rights Reserved.

Public struct UStruct BlueprintType

FInAppPurchaseReceiptInfo2

Micro-transaction purchase information

Public struct UStruct BlueprintType

FInAppPurchaseRestoreInfo2

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FInAppPurchaseRestoreResult

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FInAppPurchaseRestoreResult2

Public class

FInAppPurchaseResult

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 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

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

UInAppPurchaseCallbackProxy

Public class UClass MinimalAPI

UInAppPurchaseCallbackProxy2

Public class UClass MinimalAPI

UInAppPurchaseQueryCallbackProxy

Public class UClass MinimalAPI

UInAppPurchaseQueryCallbackProxy2

Public class UClass MinimalAPI

UInAppPurchaseRestoreCallbackProxy

Public class UClass MinimalAPI

UInAppPurchaseRestoreCallbackProxy2

Public class UClass Transient, Config

UIpConnection

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 NotPlaceable 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 NotPlaceable 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)

FVoiceEngineImplPtr

Enums

Name

Description

Public enum

EAddressResolutionState

A state system of the address resolution functionality.

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

Functions

Name Description

Public function

FText

 

EPartyReservationResult::GetDisplayString

(
    EPartyReservationResult::Type Respo...
)

Public function

const TCHAR ...

 

EPartyReservationResult::ToString

(
    EPartyReservationResult::Type Sessi...
)

Public function

FText

 

ESpectatorReservationResult::GetDisplayString

Public function

const TCHAR ...

 

ESpectatorReservationResult::ToString

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

IOnlineAchie...

 

Online::GetAchievementsInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineAchie...

 

Online::GetAchievementsInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineChatP...

 

Online::GetChatInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineChatP...

 

Online::GetChatInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineEntit...

 

Online::GetEntitlementsInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineEntit...

 

Online::GetEntitlementsInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineEvent...

 

Online::GetEventsInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineEvent...

 

Online::GetEventsInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineExter...

 

Online::GetExternalUIInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineExter...

 

Online::GetExternalUIInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineFrien...

 

Online::GetFriendsInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineFrien...

 

Online::GetFriendsInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineIdent...

 

Online::GetIdentityInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineIdent...

 

Online::GetIdentityInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineLeade...

 

Online::GetLeaderboardsInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineLeade...

 

Online::GetLeaderboardsInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function

TModularFeat...

 

Online::GetModularFeature

(
    const FName Type
)

Wrapper for IModularFeatures::IsModularFeatureAvailable and IModularFeatures::GetModularFeature

Public function Static

IOnlineParty...

 

Online::GetPartyInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineParty...

 

Online::GetPartyInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlinePrese...

 

Online::GetPresenceInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlinePrese...

 

Online::GetPresenceInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlinePurch...

 

Online::GetPurchaseInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlinePurch...

 

Online::GetPurchaseInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineSessi...

 

Online::GetSessionInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Reimplement all the interfaces of Online.h with support for UWorld accessors

Public function Static

IOnlineSessi...

 

Online::GetSessionInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineShare...

 

Online::GetSharedCloudInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineShare...

 

Online::GetSharedCloudInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineStats...

 

Online::GetStatsInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineStats...

 

Online::GetStatsInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineSubsy...

 

Online::GetSubsystem

(
    const UWorld* World,
    const FName& SubsystemName
)

Get the online subsystem for a given service

Public function Static

IOnlineTimeP...

 

Online::GetTimeInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineTimeP...

 

Online::GetTimeInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineTitle...

 

Online::GetTitleFileInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineTitle...

 

Online::GetTitleFileInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineUserC...

 

Online::GetUserCloudInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineUserC...

 

Online::GetUserCloudInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineUserP...

 

Online::GetUserInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineUserP...

 

Online::GetUserInterfaceChecked

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineSubsy...

 

Online::GetUtils()

Public function Static

IOnlineVoice...

 

Online::GetVoiceInterface

(
    const UWorld* World,
    const FName SubsystemName
)

Public function Static

IOnlineVoice...

 

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

const TCHAR ...

 

ToString

(
    EBeaconConnectionState Value
)

Public function

const TCHAR ...

 

ToString

(
    EClientRequestType RequestType
)

Public function

const TCHAR ...

 

ToString

(
    ESpectatorClientRequestType Request...
)

Variables

Name Description

Public variable

TSharedPtr< FIn...

 

GCurrentDuplicateIP

CVars.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss