Engine.OnlineGameInterface

Modifiers

dependson ( OnlineSubsystem , OnlineGameSearch )

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

Engine.OnlineGameInterface

Delegates Summary
		OnArbitrationRegistrationComplete (bool bWasSuccessful)
		OnCancelFindOnlineGamesComplete (bool bWasSuccessful)
		OnCreateOnlineGameComplete (bool bWasSuccessful)
		OnDestroyOnlineGameComplete (bool bWasSuccessful)
		OnEndOnlineGameComplete (bool bWasSuccessful)
		OnFindOnlineGamesComplete (bool bWasSuccessful)
		OnGameInviteAccepted (OnlineGameSettings GameInviteSettings)
		OnJoinOnlineGameComplete (bool bWasSuccessful)
		OnRegisterPlayerComplete (bool bWasSuccessful)
		OnStartOnlineGameComplete (bool bWasSuccessful)
		OnUnregisterPlayerComplete (bool bWasSuccessful)

Functions Summary
	bool	AcceptGameInvite (byte LocalUserNum)
		AddArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)
		AddCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate)
		AddCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)
		AddDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate)
		AddEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate)
		AddFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate)
		AddGameInviteAcceptedDelegate (byte LocalUserNum, elegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)
		AddJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate)
		AddRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)
		AddStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate)
		AddUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)
	bool	CancelFindOnlineGames ()
		ClearArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)
		ClearCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate)
		ClearCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)
		ClearDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate)
		ClearEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate)
		ClearFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate)
		ClearGameInviteAcceptedDelegate (byte LocalUserNum, elegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)
		ClearJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate)
		ClearRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)
		ClearStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate)
		ClearUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)
	bool	CreateOnlineGame (byte HostingPlayerNum, nlineGameSettings NewGameSettings)
	bool	DestroyOnlineGame ()
	bool	EndOnlineGame ()
	bool	FindOnlineGames (byte SearchingPlayerNum, nlineGameSearch SearchSettings)
	bool	FreeSearchResults (optional OnlineGameSearch Search)
	array<OnlineArbitrationRegistrant>	GetArbitratedPlayers ()
	OnlineGameSearch	GetGameSearch ()
	OnlineGameSettings	GetGameSettings ()
	EOnlineGameState	GetOnlineGameState ()
	bool	GetResolvedConnectString (out string ConnectInfo)
	bool	JoinOnlineGame (byte PlayerNum, onst out OnlineGameSearchResult DesiredGame)
	bool	QueryAuxServerInfo (byte SearchingPlayerNum, nlineGameSearch SearchSettings, onst out OnlineGameSearchResult Server)
	bool	RecalculateSkillRating (const out array<UniqueNetId> Players)
	bool	RegisterForArbitration ()
	bool	RegisterPlayer (UniqueNetId PlayerId, ool bWasInvited)
	bool	StartOnlineGame ()
	bool	UnregisterPlayer (UniqueNetId PlayerId)
	bool	UpdateOnlineGame (OnlineGameSettings UpdatedGameSettings)

OnArbitrationRegistrationComplete Source code

Delegate fired when the online game has completed registration for arbitration
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnCancelFindOnlineGamesComplete Source code

Delegate fired when the cancellation of a search for an online game has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnCreateOnlineGameComplete Source code

Delegate fired when a create request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnDestroyOnlineGameComplete Source code

Delegate fired when a destroying an online game has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnEndOnlineGameComplete Source code

Delegate fired when the online game has transitioned to the ending game state
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnFindOnlineGamesComplete Source code

Delegate fired when the search for an online game has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnGameInviteAccepted Source code

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
@param GameInviteSettings all of the game information for the game they've accepted the invite to

OnJoinOnlineGameComplete Source code

Delegate fired when the joing process for an online game has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnRegisterPlayerComplete Source code

Delegate fired when the registration process has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnStartOnlineGameComplete Source code

Delegate fired when the online game has transitioned to the started state
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnUnregisterPlayerComplete Source code

Delegate fired when the unregistration process has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

AcceptGameInvite Source code

Tells the online subsystem to accept the game invite that is currently pending
@param LocalUserNum the local user accepting the invite

AddArbitrationRegistrationCompleteDelegate Source code

Sets the notification callback to use when arbitration registration has completed
@param ArbitrationRegistrationCompleteDelegate the delegate to use for notifications

AddCancelFindOnlineGamesCompleteDelegate Source code

Adds the delegate to the list to notify with
@param CancelFindOnlineGamesCompleteDelegate the delegate to use for notifications

AddCreateOnlineGameCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the online game they created has completed the creation process
@param CreateOnlineGameCompleteDelegate the delegate to use for notifications

AddDestroyOnlineGameCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the online game they destroyed has completed the destruction process
@param DestroyOnlineGameCompleteDelegate the delegate to use for notifications

AddEndOnlineGameCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the online game has transitioned to the ending state.
@param EndOnlineGameCompleteDelegate the delegate to use for notifications

AddFindOnlineGamesCompleteDelegate Source code

Adds the delegate used to notify the gameplay code that the search they kicked off has completed
@param FindOnlineGamesCompleteDelegate the delegate to use for notifications

AddGameInviteAcceptedDelegate Source code

Sets the delegate used to notify the gameplay code when a game invite has been accepted
@param LocalUserNum the user to request notification for
@param GameInviteAcceptedDelegate the delegate to use for notifications

AddJoinOnlineGameCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the join request they kicked off has completed
@param JoinOnlineGameCompleteDelegate the delegate to use for notifications

AddRegisterPlayerCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the player registration request they submitted has completed
@param RegisterPlayerCompleteDelegate the delegate to use for notifications

AddStartOnlineGameCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the online game has transitioned to the started state.
@param StartOnlineGameCompleteDelegate the delegate to use for notifications

AddUnregisterPlayerCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the player unregistration request they submitted has completed
@param UnregisterPlayerCompleteDelegate the delegate to use for notifications

CancelFindOnlineGames Source code

Cancels the current search in progress if possible for that search type
@return true if successful searching for sessions, false otherwise

ClearArbitrationRegistrationCompleteDelegate Source code

Removes the delegate from the list of notifications
@param ArbitrationRegistrationCompleteDelegate the delegate to use for notifications

ClearCancelFindOnlineGamesCompleteDelegate Source code

Removes the delegate from the notify list
@param CancelFindOnlineGamesCompleteDelegate the delegate to use for notifications

ClearCreateOnlineGameCompleteDelegate Source code

Removes the delegate from the list of notifications
@param CreateOnlineGameCompleteDelegate the delegate to use for notifications

ClearDestroyOnlineGameCompleteDelegate Source code

Removes the delegate from the list of notifications
@param DestroyOnlineGameCompleteDelegate the delegate to use for notifications

ClearEndOnlineGameCompleteDelegate Source code

Removes the delegate from the list of notifications
@param EndOnlineGameCompleteDelegate the delegate to use for notifications

ClearFindOnlineGamesCompleteDelegate Source code

Removes the delegate from the notify list
@param FindOnlineGamesCompleteDelegate the delegate to use for notifications

ClearGameInviteAcceptedDelegate Source code

Removes the delegate from the list of notifications
@param GameInviteAcceptedDelegate the delegate to use for notifications

ClearJoinOnlineGameCompleteDelegate Source code

Removes the delegate from the list of notifications
@param JoinOnlineGameCompleteDelegate the delegate to use for notifications

ClearRegisterPlayerCompleteDelegate Source code

Removes the delegate from the list of notifications
@param RegisterPlayerCompleteDelegate the delegate to use for notifications

ClearStartOnlineGameCompleteDelegate Source code

Removes the delegate from the list of notifications
@param StartOnlineGameCompleteDelegate the delegate to use for notifications

ClearUnregisterPlayerCompleteDelegate Source code

Removes the delegate from the list of notifications
@param UnregisterPlayerCompleteDelegate the delegate to use for notifications

CreateOnlineGame Source code

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.
@param HostingPlayerNum the index of the player hosting the match
@param NewGameSettings the settings to use for the new game session
@return true if successful creating the session, false otherwsie

DestroyOnlineGame Source code

Destroys the current online game NOTE: online game de-registration is an async process and does not complete until the OnDestroyOnlineGameComplete delegate is called.
@return true if successful destroying the session, false otherwsie

EndOnlineGame Source code

Marks an online game as having been ended
@return true if the call succeeds, false otherwise

FindOnlineGames Source code

Searches for games matching the settings specified
@param SearchingPlayerNum the index of the player searching for a match
@param SearchSettings the desired settings that the returned sessions will have
@return true if successful searching for sessions, false otherwise

FreeSearchResults Source code

Cleans up any platform specific allocated data contained in the search results
@param Search the object to free search results for
@return true if successful, false otherwise

GetArbitratedPlayers Source code

Returns the list of arbitrated players for the arbitrated session

GetGameSearch Source code

Returns the currently set game search object

GetGameSettings Source code

Returns the currently set game settings

GetOnlineGameState Source code

Returns the current state of the online game

GetResolvedConnectString Source code

Returns the platform specific connection information for joining the match. Call this function from the delegate of join completion
@param ConnectInfo the out var containing the platform specific connection information
@return true if the call was successful, false otherwise

JoinOnlineGame Source code

Joins the game specified
@param PlayerNum the index of the player searching for a match
@param DesiredGame the desired game to join
@return true if the call completed successfully, false otherwise

QueryAuxServerInfo Source code

Query an individual server for additional information

RecalculateSkillRating Source code

Updates the current session's skill rating using the list of players' skills
@param Players the set of players to use in the skill calculation
@return true if the update succeeded, false otherwise

RegisterForArbitration Source code

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

RegisterPlayer Source code

Registers a player with the online service as being part of the online game
@param UniquePlayerId the player to register with the online service
@param bWasInvited whether the player was invited to the game or searched for it
@return true if the call succeeds, false otherwise

StartOnlineGame Source code

Marks an online game as in progress (as opposed to being in lobby)
@return true if the call succeeds, false otherwise

UnregisterPlayer Source code

Unregisters a player with the online service as being part of the online game
@param PlayerId the player to unregister with the online service
@return true if the call succeeds, false otherwise

UpdateOnlineGame Source code

Updates the localized settings/properties for the game in question
@param UpdatedGameSettings the object to update the game settings with
@return true if successful creating the session, false otherwsie

defaultproperties
{
   Name="Default__OnlineGameInterface"
   ObjectArchetype=Interface'Core.Default__Interface'
}