UE3:OnlineGameInterface (UT3)

Interface >> OnlineGameInterface

Package: 

Engine

Known implementing classes:

OnlineGameInterfaceGameSpy, OnlineGameInterfaceImpl, OnlineSubsystemLive

This interface in other games:

UDK

This interface deals with the online games. It creates, destroys, performs searches for online games. This interface is overloaded to provide custom matchmaking services

Delegates

OnArbitrationRegistrationComplete

delegate OnArbitrationRegistrationComplete (bool bWasSuccessful)

Delegate fired when the online game has completed registration for arbitration

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnCancelFindOnlineGamesComplete

delegate OnCancelFindOnlineGamesComplete (bool bWasSuccessful)

Delegate fired when the cancellation of a search for an online game has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnCreateOnlineGameComplete

delegate OnCreateOnlineGameComplete (bool bWasSuccessful)

Delegate fired when a create request has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnDestroyOnlineGameComplete

delegate OnDestroyOnlineGameComplete (bool bWasSuccessful)

Delegate fired when a destroying an online game has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnEndOnlineGameComplete

delegate OnEndOnlineGameComplete (bool bWasSuccessful)

Delegate fired when the online game has transitioned to the ending game state

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnFindOnlineGamesComplete

delegate OnFindOnlineGamesComplete (bool bWasSuccessful)

Delegate fired when the search for an online game has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnGameInviteAccepted

delegate OnGameInviteAccepted (OnlineGameSettings GameInviteSettings)

Called when a user accepts a game invitation. Allows the gameplay code a chance to clean up any existing state before accepting the invite. The invite must be accepted by calling AcceptGameInvite() on the OnlineGameInterface after clean up has completed

Parameters:

• GameInviteSettings - all of the game information for the game they've accepted the invite to

OnJoinOnlineGameComplete

delegate OnJoinOnlineGameComplete (bool bWasSuccessful)

Delegate fired when the joing process for an online game has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnRegisterPlayerComplete

delegate OnRegisterPlayerComplete (bool bWasSuccessful)

Delegate fired when the registration process has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnStartOnlineGameComplete

delegate OnStartOnlineGameComplete (bool bWasSuccessful)

Delegate fired when the online game has transitioned to the started state

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnUnregisterPlayerComplete

delegate OnUnregisterPlayerComplete (bool bWasSuccessful)

Delegate fired when the unregistration process has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

Instance functions

AcceptGameInvite

function bool AcceptGameInvite (byte LocalUserNum)

Tells the online subsystem to accept the game invite that is currently pending

Parameters:

• LocalUserNum - the local user accepting the invite

AddArbitrationRegistrationCompleteDelegate

function AddArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)

Sets the notification callback to use when arbitration registration has completed

Parameters:

• ArbitrationRegistrationCompleteDelegate - the delegate to use for notifications

AddCancelFindOnlineGamesCompleteDelegate

function AddCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate)

Adds the delegate to the list to notify with

Parameters:

• CancelFindOnlineGamesCompleteDelegate - the delegate to use for notifications

AddCreateOnlineGameCompleteDelegate

function AddCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)

Sets the delegate used to notify the gameplay code that the online game they created has completed the creation process

Parameters:

• CreateOnlineGameCompleteDelegate - the delegate to use for notifications

AddDestroyOnlineGameCompleteDelegate

function AddDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate)

Sets the delegate used to notify the gameplay code that the online game they destroyed has completed the destruction process

Parameters:

• DestroyOnlineGameCompleteDelegate - the delegate to use for notifications

AddEndOnlineGameCompleteDelegate

function AddEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate)

Sets the delegate used to notify the gameplay code that the online game has transitioned to the ending state.

Parameters:

• EndOnlineGameCompleteDelegate - the delegate to use for notifications

AddFindOnlineGamesCompleteDelegate

function AddFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate)

Adds the delegate used to notify the gameplay code that the search they kicked off has completed

Parameters:

• FindOnlineGamesCompleteDelegate - the delegate to use for notifications

AddGameInviteAcceptedDelegate

function AddGameInviteAcceptedDelegate (byte LocalUserNum, delegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)

Sets the delegate used to notify the gameplay code when a game invite has been accepted

Parameters:

• LocalUserNum - the user to request notification for
• GameInviteAcceptedDelegate - the delegate to use for notifications

AddJoinOnlineGameCompleteDelegate

function AddJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate)

Sets the delegate used to notify the gameplay code that the join request they kicked off has completed

Parameters:

• JoinOnlineGameCompleteDelegate - the delegate to use for notifications

AddRegisterPlayerCompleteDelegate

function AddRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)

Sets the delegate used to notify the gameplay code that the player registration request they submitted has completed

Parameters:

• RegisterPlayerCompleteDelegate - the delegate to use for notifications

AddStartOnlineGameCompleteDelegate

function AddStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate)

Sets the delegate used to notify the gameplay code that the online game has transitioned to the started state.

Parameters:

• StartOnlineGameCompleteDelegate - the delegate to use for notifications

AddUnregisterPlayerCompleteDelegate

function AddUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)

Sets the delegate used to notify the gameplay code that the player unregistration request they submitted has completed

Parameters:

• UnregisterPlayerCompleteDelegate - the delegate to use for notifications

CancelFindOnlineGames

function bool CancelFindOnlineGames ()

Cancels the current search in progress if possible for that search type

Returns:

true if successful searching for sessions, false otherwise

ClearArbitrationRegistrationCompleteDelegate

function ClearArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• ArbitrationRegistrationCompleteDelegate - the delegate to use for notifications

ClearCancelFindOnlineGamesCompleteDelegate

function ClearCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate)

Removes the delegate from the notify list

Parameters:

• CancelFindOnlineGamesCompleteDelegate - the delegate to use for notifications

ClearCreateOnlineGameCompleteDelegate

function ClearCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• CreateOnlineGameCompleteDelegate - the delegate to use for notifications

ClearDestroyOnlineGameCompleteDelegate

function ClearDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• DestroyOnlineGameCompleteDelegate - the delegate to use for notifications

ClearEndOnlineGameCompleteDelegate

function ClearEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• EndOnlineGameCompleteDelegate - the delegate to use for notifications

ClearFindOnlineGamesCompleteDelegate

function ClearFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate)

Removes the delegate from the notify list

Parameters:

• FindOnlineGamesCompleteDelegate - the delegate to use for notifications

ClearGameInviteAcceptedDelegate

function ClearGameInviteAcceptedDelegate (byte LocalUserNum, delegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)

Removes the delegate from the list of notifications

Parameters:

• GameInviteAcceptedDelegate - the delegate to use for notifications

ClearJoinOnlineGameCompleteDelegate

function ClearJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• JoinOnlineGameCompleteDelegate - the delegate to use for notifications

ClearRegisterPlayerCompleteDelegate

function ClearRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• RegisterPlayerCompleteDelegate - the delegate to use for notifications

ClearStartOnlineGameCompleteDelegate

function ClearStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• StartOnlineGameCompleteDelegate - the delegate to use for notifications

ClearUnregisterPlayerCompleteDelegate

function ClearUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• UnregisterPlayerCompleteDelegate - the delegate to use for notifications

CreateOnlineGame

function bool CreateOnlineGame (byte HostingPlayerNum, OnlineGameSettings NewGameSettings)

Creates an online game based upon the settings object specified. NOTE: online game registration is an async process and does not complete until the OnCreateOnlineGameComplete delegate is called.

Parameters:

• HostingPlayerNum - the index of the player hosting the match
• NewGameSettings - the settings to use for the new game session

Returns:

true if successful creating the session, false otherwsie

DestroyOnlineGame

function bool DestroyOnlineGame ()

Destroys the current online game NOTE: online game de-registration is an async process and does not complete until the OnDestroyOnlineGameComplete delegate is called.

Returns:

true if successful destroying the session, false otherwsie

EndOnlineGame

function bool EndOnlineGame ()

Marks an online game as having been ended

Returns:

true if the call succeeds, false otherwise

FindOnlineGames

function bool FindOnlineGames (byte SearchingPlayerNum, OnlineGameSearch SearchSettings)

Searches for games matching the settings specified

Parameters:

• SearchingPlayerNum - the index of the player searching for a match
• SearchSettings - the desired settings that the returned sessions will have

Returns:

true if successful searching for sessions, false otherwise

FreeSearchResults

function bool FreeSearchResults (optional OnlineGameSearch Search)

Cleans up any platform specific allocated data contained in the search results

Parameters:

• Search - the object to free search results for

Returns:

true if successful, false otherwise

GetArbitratedPlayers

function array<OnlineSubsystem.OnlineArbitrationRegistrant> GetArbitratedPlayers ()

Returns the list of arbitrated players for the arbitrated session

GetGameSearch

function OnlineGameSearch GetGameSearch ()

Returns the currently set game search object

GetGameSettings

function OnlineGameSettings GetGameSettings ()

Returns the currently set game settings

GetOnlineGameState

function OnlineSubsystem.EOnlineGameState GetOnlineGameState ()

Returns the current state of the online game

GetResolvedConnectString

function bool GetResolvedConnectString (out string ConnectInfo)

Returns the platform specific connection information for joining the match. Call this function from the delegate of join completion

Parameters:

• ConnectInfo - the out var containing the platform specific connection information

Returns:

true if the call was successful, false otherwise

JoinOnlineGame

function bool JoinOnlineGame (byte PlayerNum, const out OnlineGameSearch.OnlineGameSearchResult DesiredGame)

Joins the game specified

Parameters:

• PlayerNum - the index of the player searching for a match
• DesiredGame - the desired game to join

Returns:

true if the call completed successfully, false otherwise

RecalculateSkillRating

function bool RecalculateSkillRating (const out array<OnlineSubsystem.UniqueNetId> Players)

Updates the current session's skill rating using the list of players' skills

Parameters:

• Players - the set of players to use in the skill calculation

Returns:

true if the update succeeded, false otherwise

RegisterForArbitration

function bool RegisterForArbitration ()

Tells the game to register with the underlying arbitration server if available

RegisterPlayer

function bool RegisterPlayer (OnlineSubsystem.UniqueNetId PlayerId, bool bWasInvited)

Registers a player with the online service as being part of the online game

Parameters:

• UniquePlayerId - the player to register with the online service
• bWasInvited - whether the player was invited to the game or searched for it

Returns:

true if the call succeeds, false otherwise

StartOnlineGame

function bool StartOnlineGame ()

Marks an online game as in progress (as opposed to being in lobby)

Returns:

true if the call succeeds, false otherwise

UnregisterPlayer

function bool UnregisterPlayer (OnlineSubsystem.UniqueNetId PlayerId)

Unregisters a player with the online service as being part of the online game

Parameters:

• PlayerId - the player to unregister with the online service

Returns:

true if the call succeeds, false otherwise

UpdateOnlineGame

function bool UpdateOnlineGame (OnlineGameSettings UpdatedGameSettings)

Updates the localized settings/properties for the game in question

Parameters:

• UpdatedGameSettings - the object to update the game settings with

Returns:

true if successful creating the session, false otherwsie