UE3:OnlineGameInterfaceImpl instance functions (UDK)

Object >> OnlineGameInterfaceImpl (instance functions)

OnlineGameInterfaceImpl instance functions in other games:

UT3

Instance functions

AcceptGameInvite

function bool AcceptGameInvite (byte LocalUserNum, name SessionName)

Specified by: OnlineGameInterface.AcceptGameInvite

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

Parameters:

• LocalUserNum - the local user accepting the invite
• SessionName - the name of the session this invite is to be known as

Returns:

true if the game invite was able to be accepted, false otherwise

AddArbitrationRegistrationCompleteDelegate

function AddArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)

Specified by: OnlineGameInterface.AddArbitrationRegistrationCompleteDelegate

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)

Specified by: OnlineGameInterface.AddCancelFindOnlineGamesCompleteDelegate

Adds the delegate to the list to notify with

Parameters:

• CancelFindOnlineGamesCompleteDelegate - the delegate to use for notifications

AddCreateOnlineGameCompleteDelegate

function AddCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.AddCreateOnlineGameCompleteDelegate

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)

Specified by: OnlineGameInterface.AddDestroyOnlineGameCompleteDelegate

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)

Specified by: OnlineGameInterface.AddEndOnlineGameCompleteDelegate

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)

Specified by: OnlineGameInterface.AddFindOnlineGamesCompleteDelegate

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)

Specified by: OnlineGameInterface.AddGameInviteAcceptedDelegate

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)

Specified by: OnlineGameInterface.AddJoinOnlineGameCompleteDelegate

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)

Specified by: OnlineGameInterface.AddRegisterPlayerCompleteDelegate

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)

Specified by: OnlineGameInterface.AddStartOnlineGameCompleteDelegate

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)

Specified by: OnlineGameInterface.AddUnregisterPlayerCompleteDelegate

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

AddUpdateOnlineGameCompleteDelegate

function AddUpdateOnlineGameCompleteDelegate (delegate<OnUpdateOnlineGameComplete> UpdateOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.AddUpdateOnlineGameCompleteDelegate

Adds a delegate to the list of objects that want to be notified

Parameters:

• UpdateOnlineGameCompleteDelegate - the delegate to use for notifications

ClearArbitrationRegistrationCompleteDelegate

function ClearArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)

Specified by: OnlineGameInterface.ClearArbitrationRegistrationCompleteDelegate

Removes the specified delegate from the notification list

Parameters:

• ArbitrationRegistrationCompleteDelegate - the delegate to use for notifications

ClearCancelFindOnlineGamesCompleteDelegate

function ClearCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate)

Specified by: OnlineGameInterface.ClearCancelFindOnlineGamesCompleteDelegate

Removes the delegate from the notify list

Parameters:

• CancelFindOnlineGamesCompleteDelegate - the delegate to use for notifications

ClearCreateOnlineGameCompleteDelegate

function ClearCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearCreateOnlineGameCompleteDelegate

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

ClearDestroyOnlineGameCompleteDelegate

function ClearDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearDestroyOnlineGameCompleteDelegate

Removes the delegate from the notification list

Parameters:

• DestroyOnlineGameCompleteDelegate - the delegate to use for notifications

ClearEndOnlineGameCompleteDelegate

function ClearEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearEndOnlineGameCompleteDelegate

Removes the delegate from the notify list

Parameters:

• EndOnlineGameCompleteDelegate - the delegate to use for notifications

ClearFindOnlineGamesCompleteDelegate

function ClearFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate)

Specified by: OnlineGameInterface.ClearFindOnlineGamesCompleteDelegate

Removes the delegate from the notify list

Parameters:

• FindOnlineGamesCompleteDelegate - the delegate to use for notifications

ClearGameInviteAcceptedDelegate

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

Specified by: OnlineGameInterface.ClearGameInviteAcceptedDelegate

Removes the specified delegate from the notification list

Parameters:

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

ClearJoinOnlineGameCompleteDelegate

function ClearJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearJoinOnlineGameCompleteDelegate

Removes the delegate from the notify list

Parameters:

• JoinOnlineGameCompleteDelegate - the delegate to use for notifications

ClearRegisterPlayerCompleteDelegate

function ClearRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)

Specified by: OnlineGameInterface.ClearRegisterPlayerCompleteDelegate

Removes the delegate from the notify list

Parameters:

• RegisterPlayerCompleteDelegate - the delegate to use for notifications

ClearStartOnlineGameCompleteDelegate

function ClearStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearStartOnlineGameCompleteDelegate

Removes the delegate from the notify list

Parameters:

• StartOnlineGameCompleteDelegate - the delegate to use for notifications

ClearUnregisterPlayerCompleteDelegate

function ClearUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)

Specified by: OnlineGameInterface.ClearUnregisterPlayerCompleteDelegate

Removes the delegate from the notify list

Parameters:

• UnregisterPlayerCompleteDelegate - the delegate to use for notifications

ClearUpdateOnlineGameCompleteDelegate

function ClearUpdateOnlineGameCompleteDelegate (delegate<OnUpdateOnlineGameComplete> UpdateOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearUpdateOnlineGameCompleteDelegate

Removes a delegate from the list of objects that want to be notified

Parameters:

• UpdateOnlineGameCompleteDelegate - the delegate to use for notifications

GetArbitratedPlayers

function array<OnlineSubsystem.OnlineArbitrationRegistrant> GetArbitratedPlayers (name SessionName)

Specified by: OnlineGameInterface.GetArbitratedPlayers

Returns the list of arbitrated players for the arbitrated session

Parameters:

• SessionName - the name of the session to get the arbitration results for

Returns:

the list of players that are registered for this session

GetGameSearch

function OnlineGameSearch GetGameSearch ()

Specified by: OnlineGameInterface.GetGameSearch

Returns the currently set game search object

GetGameSettings

function OnlineGameSettings GetGameSettings (name SessionName)

Specified by: OnlineGameInterface.GetGameSettings

Returns the game settings object for the session with a matching name

Parameters:

• SessionName - the name of the session to return

Returns:

the game settings for this session name

QueryNonAdvertisedData

function bool QueryNonAdvertisedData (int StartAt, int NumberToQuery)

Specified by: OnlineGameInterface.QueryNonAdvertisedData

Fetches the additional data a session exposes outside of the online service. NOTE: notifications will come from the OnFindOnlineGamesComplete delegate

Parameters:

• StartAt - the search result index to start gathering the extra information for
• NumberToQuery - the number of additional search results to get the data for

Returns:

true if the query was started, false otherwise

ReadPlatformSpecificSessionInfoBySessionName

function bool ReadPlatformSpecificSessionInfoBySessionName (name SessionName, out byte PlatformSpecificInfo[68])

Specified by: OnlineGameInterface.ReadPlatformSpecificSessionInfoBySessionName

Serializes the platform specific data into the provided buffer for the specified settings object. NOTE: This can only be done for a session that is bound to the online system

Parameters:

• GameSettings - the game to copy the platform specific data for
• PlatformSpecificInfo - the buffer to fill with the platform specific information

Returns:

true if successful reading the data for the session, false otherwise

RecalculateSkillRating

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

Specified by: OnlineGameInterface.RecalculateSkillRating

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

Parameters:

• SessionName - the name of the session to update the skill rating for
• Players - the set of players to use in the skill calculation

Returns:

true if the update succeeded, false otherwise

RegisterForArbitration

function bool RegisterForArbitration (name SessionName)

Specified by: OnlineGameInterface.RegisterForArbitration

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

Parameters:

• SessionName - the name of the session to register for arbitration with

RegisterPlayer

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

Specified by: OnlineGameInterface.RegisterPlayer

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

Parameters:

• SessionName - the name of the session the player is joining
• 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

UnregisterPlayer

function bool UnregisterPlayer (name SessionName, OnlineSubsystem.UniqueNetId PlayerId)

Specified by: OnlineGameInterface.UnregisterPlayer

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

Parameters:

• SessionName - the name of the session the player is leaving
• PlayerId - the player to unregister with the online service

Returns:

true if the call succeeds, false otherwise

UpdateOnlineGame

function bool UpdateOnlineGame (name SessionName, OnlineGameSettings UpdatedGameSettings, optional bool bShouldRefreshOnlineData)

Specified by: OnlineGameInterface.UpdateOnlineGame

Updates the localized settings/properties for the game in question. Updates the QoS packet if needed (starting & restarting QoS).

Parameters:

• SessionName - the name of the session to update
• UpdatedGameSettings - the object to update the game settings with
• bShouldRefreshOnlineData - whether to submit the data to the backend or not

Returns:

true if successful creating the session, false otherwsie