Difference between revisions of "UE3:OnlineGameInterface (UT3)"

Revision as of 09:11, 17 May 2008 (edit) Wormbo (Talk | contribs) (Auto-generated page)		Latest revision as of 02:05, 16 August 2009 (edit) (undo) Wormbo (Talk | contribs) m (added missing members)
Line 399:		Line 399:
	'''Returns:'''		'''Returns:'''
	:true if the call completed successfully, false otherwise		:true if the call completed successfully, false otherwise
		+
		+	====QueryAuxServerInfo====
		+	{{code|function [[bool]] '''QueryAuxServerInfo''' ([[byte]] '''SearchingPlayerNum''', {{cl|OnlineGameSearch}} '''SearchSettings''', const out {{tl|OnlineGameSearchResult|OnlineGameSearch}} '''Server''')}}
		+
		+	Query an individual server for additional information
	====RecalculateSkillRating====		====RecalculateSkillRating====

---

Latest revision as of 02:05, 16 August 2009

Package: 

Engine

Known implementing classes:

OnlineGameInterfaceGameSpy, OnlineGameInterfaceImpl, OnlineSubsystemLive

This interface in other games:

UDK

This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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[edit]

OnArbitrationRegistrationComplete[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

AcceptGameInvite[edit]

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

Parameters:

• LocalUserNum - the local user accepting the invite

AddArbitrationRegistrationCompleteDelegate[edit]

Sets the notification callback to use when arbitration registration has completed

Parameters:

• ArbitrationRegistrationCompleteDelegate - the delegate to use for notifications

AddCancelFindOnlineGamesCompleteDelegate[edit]

Adds the delegate to the list to notify with

Parameters:

• CancelFindOnlineGamesCompleteDelegate - the delegate to use for notifications

AddCreateOnlineGameCompleteDelegate[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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

Returns:

true if successful searching for sessions, false otherwise

ClearArbitrationRegistrationCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• ArbitrationRegistrationCompleteDelegate - the delegate to use for notifications

ClearCancelFindOnlineGamesCompleteDelegate[edit]

Removes the delegate from the notify list

Parameters:

• CancelFindOnlineGamesCompleteDelegate - the delegate to use for notifications

ClearCreateOnlineGameCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• CreateOnlineGameCompleteDelegate - the delegate to use for notifications

ClearDestroyOnlineGameCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• DestroyOnlineGameCompleteDelegate - the delegate to use for notifications

ClearEndOnlineGameCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• EndOnlineGameCompleteDelegate - the delegate to use for notifications

ClearFindOnlineGamesCompleteDelegate[edit]

Removes the delegate from the notify list

Parameters:

• FindOnlineGamesCompleteDelegate - the delegate to use for notifications

ClearGameInviteAcceptedDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• GameInviteAcceptedDelegate - the delegate to use for notifications

ClearJoinOnlineGameCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• JoinOnlineGameCompleteDelegate - the delegate to use for notifications

ClearRegisterPlayerCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• RegisterPlayerCompleteDelegate - the delegate to use for notifications

ClearStartOnlineGameCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• StartOnlineGameCompleteDelegate - the delegate to use for notifications

ClearUnregisterPlayerCompleteDelegate[edit]

Removes the delegate from the list of notifications

Parameters:

• UnregisterPlayerCompleteDelegate - the delegate to use for notifications

CreateOnlineGame[edit]

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[edit]

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[edit]

Marks an online game as having been ended

Returns:

true if the call succeeds, false otherwise

FindOnlineGames[edit]

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[edit]

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[edit]

Returns the list of arbitrated players for the arbitrated session

GetGameSearch[edit]

Returns the currently set game search object

GetGameSettings[edit]

Returns the currently set game settings

GetOnlineGameState[edit]

Returns the current state of the online game

GetResolvedConnectString[edit]

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[edit]

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

QueryAuxServerInfo[edit]

Query an individual server for additional information

RecalculateSkillRating[edit]

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[edit]

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

RegisterPlayer[edit]

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[edit]

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

Returns:

true if the call succeeds, false otherwise

UnregisterPlayer[edit]

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[edit]

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