OnlineSubsystemGameSpy.OnlineGameInterfaceGameSpy

Extends

OnlineGameInterfaceImpl

Modifiers

within OnlineSubsystemCommonImpl native implements ( OnlineGameInterface ) config ( Engine )

Class that implements the GameSpy specific functionality

Core.Object
|   
+-- IpDrv.OnlineGameInterfaceImpl
   |   
   +-- OnlineSubsystemGameSpy.OnlineGameInterfaceGameSpy

Delegates Summary
		OnGameInviteAccepted (OnlineGameSettings GameInviteSettings)
		OnRegisterPlayerComplete (bool bWasSuccessful)
		OnUnregisterPlayerComplete (bool bWasSuccessful)

Functions Summary
	bool	AcceptGameInvite (byte LocalUserNum)
		AddGameInviteAcceptedDelegate (byte LocalUserNum, elegate<OnGameInviteAccepted> GameInviteAcceptedDelegate))
		AddRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate))
		AddUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate))
		ClearGameInviteAcceptedDelegate (byte LocalUserNum, elegate<OnGameInviteAccepted> GameInviteAcceptedDelegate))
		ClearRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate))
		ClearUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate))
	bool	FreeSearchResults (OnlineGameSearch Search)
	bool	QueryAuxServerInfo (byte SearchingPlayerNum, nlineGameSearch SearchSettings, onst out OnlineGameSearchResult Server)
	bool	RecalculateSkillRating (const out array<UniqueNetId> Players)
	bool	RegisterPlayer (UniqueNetId PlayerId, ool bWasInvited)
	bool	UnregisterPlayer (UniqueNetId PlayerId)
	bool	UpdateOnlineGame (OnlineGameSettings UpdatedGameSettings)

GameInviteAcceptedDelegates Source code

The list of delegates to notify when a game invite is accepted

InviteGameSearch Source code

Game game settings associated with this invite

InviteLocationUrl Source code

The last invite's URL information

PackedServerInfo Source code

Holds an array of values that are published in the map name field

QR2DataBindableKeyNames Source code

The list of databindable properties that are registered as keys

QR2FirstDataBindableKeyId Source code

The first databinding property key id in the list

QR2FirstPropertyKeyId Source code

The first property key id in the list

QR2FirstSettingKeyId Source code

The first localized setting key id in the list

QR2Handle Source code

stores a handle to the QR2 instance

QR2NumDataBindableKeys Source code

The number of databinding property keys

QR2NumPropertyKeys Source code

The number of registered property keys

QR2NumSettingKeys Source code

The number of localized settings keys

QR2OwningPlayerIdKeyId Source code

The QR2 key id for the player id

RegisterPlayerCompleteDelegates Source code

This is the list of requested delegates to fire when complete

RemainingAddlSearchCriteria Source code

Temp variable to hold additional search criteria that has not been processed yet

UnregisterPlayerCompleteDelegates Source code

This is the list of requested delegates to fire when complete

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

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

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

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

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

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

ClearGameInviteAcceptedDelegate Source code

Removes the specified delegate from the notification list
@param LocalUserNum the user to request notification for
@param GameInviteAcceptedDelegate the delegate to use for notifications

ClearRegisterPlayerCompleteDelegate Source code

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

ClearUnregisterPlayerCompleteDelegate Source code

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

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

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

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

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__OnlineGameInterfaceGameSpy"
   ObjectArchetype=OnlineGameInterfaceImpl'IpDrv.Default__OnlineGameInterfaceImpl'
}