Cogito, ergo sum

UE3:OnlineGameInterfaceGameSpy (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> OnlineGameInterfaceImpl >> OnlineGameInterfaceGameSpy
Package: 
OnlineSubsystemGameSpy
Within class: 
OnlineSubsystemCommonImpl
Implemented interfaces
OnlineGameInterface

Class that implements the GameSpy specific functionality

Properties[edit]

GameInviteAcceptedDelegates[edit]

Type: array<delegate<OnGameInviteAccepted> >

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

InviteGameSearch[edit]

Type: OnlineGameSearch

Modifiers: const, private

Game game settings associated with this invite

InviteLocationUrl[edit]

Type: string

Modifiers: const, private

The last invite's URL information

PackedServerInfo[edit]

Type: string

Modifiers: const

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

QR2DataBindableKeyNames[edit]

Type: array<name>

Modifiers: const

The list of databindable properties that are registered as keys

QR2FirstDataBindableKeyId[edit]

Type: int

Modifiers: const

The first databinding property key id in the list

QR2FirstPropertyKeyId[edit]

Type: int

Modifiers: const

The first property key id in the list

QR2FirstSettingKeyId[edit]

Type: int

Modifiers: const

The first localized setting key id in the list

QR2Handle[edit]

Type: pointer{struct qr2_implementation_s}

Modifiers: native, const, transient, private

stores a handle to the QR2 instance

QR2NumDataBindableKeys[edit]

Type: int

Modifiers: const

The number of databinding property keys

QR2NumPropertyKeys[edit]

Type: int

Modifiers: const

The number of registered property keys

QR2NumSettingKeys[edit]

Type: int

Modifiers: const

The number of localized settings keys

QR2OwningPlayerIdKeyId[edit]

Type: int

Modifiers: const

The QR2 key id for the player id

RegisterPlayerCompleteDelegates[edit]

Type: array<delegate<OnRegisterPlayerComplete> >

This is the list of requested delegates to fire when complete

RemainingAddlSearchCriteria[edit]

Type: string

Modifiers: private, transient

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

UnregisterPlayerCompleteDelegates[edit]

Type: array<delegate<OnUnregisterPlayerComplete> >

This is the list of requested delegates to fire when complete

Delegates[edit]

OnGameInviteAccepted[edit]

delegate OnGameInviteAccepted (OnlineGameSettings GameInviteSettings)

Overrides: OnlineGameInterfaceImpl.OnGameInviteAccepted

Specified by: OnlineGameInterface.OnGameInviteAccepted

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

OnRegisterPlayerComplete[edit]

delegate OnRegisterPlayerComplete (bool bWasSuccessful)

Overrides: OnlineGameInterfaceImpl.OnRegisterPlayerComplete

Specified by: OnlineGameInterface.OnRegisterPlayerComplete

Delegate fired when the registration process has completed

Parameters:

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

OnUnregisterPlayerComplete[edit]

delegate OnUnregisterPlayerComplete (bool bWasSuccessful)

Overrides: OnlineGameInterfaceImpl.OnUnregisterPlayerComplete

Specified by: OnlineGameInterface.OnUnregisterPlayerComplete

Delegate fired when the unregistration process has completed

Parameters:

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

Functions[edit]

Native functions[edit]

AcceptGameInvite[edit]

native function bool AcceptGameInvite (byte LocalUserNum)

Overrides: OnlineGameInterfaceImpl.AcceptGameInvite

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

FreeSearchResults[edit]

native function bool FreeSearchResults (OnlineGameSearch Search)

Overrides: OnlineGameInterfaceImpl.FreeSearchResults

Specified by: OnlineGameInterface.FreeSearchResults

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

QueryAuxServerInfo[edit]

native function bool QueryAuxServerInfo (byte SearchingPlayerNum, OnlineGameSearch SearchSettings, const out OnlineGameSearch.OnlineGameSearchResult Server)

Overrides: OnlineGameInterfaceImpl.QueryAuxServerInfo

Specified by: OnlineGameInterface.QueryAuxServerInfo

Query an individual server for additional information

RecalculateSkillRating[edit]

native function bool RecalculateSkillRating (const out array<OnlineSubsystem.UniqueNetIdPlayers)

Overrides: OnlineGameInterfaceImpl.RecalculateSkillRating

Specified by: OnlineGameInterface.RecalculateSkillRating

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

RegisterPlayer[edit]

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

Overrides: OnlineGameInterfaceImpl.RegisterPlayer

Specified by: OnlineGameInterface.RegisterPlayer

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

UnregisterPlayer[edit]

native function bool UnregisterPlayer (OnlineSubsystem.UniqueNetId PlayerId)

Overrides: OnlineGameInterfaceImpl.UnregisterPlayer

Specified by: OnlineGameInterface.UnregisterPlayer

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]

native function bool UpdateOnlineGame (OnlineGameSettings UpdatedGameSettings)

Overrides: OnlineGameInterfaceImpl.UpdateOnlineGame

Specified by: OnlineGameInterface.UpdateOnlineGame

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

Other instance functions[edit]

AddGameInviteAcceptedDelegate[edit]

function AddGameInviteAcceptedDelegate (byte LocalUserNum, delegate<OnGameInviteAcceptedGameInviteAcceptedDelegate)

Overrides: OnlineGameInterfaceImpl.AddGameInviteAcceptedDelegate

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

AddRegisterPlayerCompleteDelegate[edit]

function AddRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerCompleteRegisterPlayerCompleteDelegate)

Overrides: OnlineGameInterfaceImpl.AddRegisterPlayerCompleteDelegate

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

AddUnregisterPlayerCompleteDelegate[edit]

function AddUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerCompleteUnregisterPlayerCompleteDelegate)

Overrides: OnlineGameInterfaceImpl.AddUnregisterPlayerCompleteDelegate

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

ClearGameInviteAcceptedDelegate[edit]

function ClearGameInviteAcceptedDelegate (byte LocalUserNum, delegate<OnGameInviteAcceptedGameInviteAcceptedDelegate)

Overrides: OnlineGameInterfaceImpl.ClearGameInviteAcceptedDelegate

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

ClearRegisterPlayerCompleteDelegate[edit]

function ClearRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerCompleteRegisterPlayerCompleteDelegate)

Overrides: OnlineGameInterfaceImpl.ClearRegisterPlayerCompleteDelegate

Specified by: OnlineGameInterface.ClearRegisterPlayerCompleteDelegate

Removes the specified delegate from the notification list

Parameters:

  • RegisterPlayerCompleteDelegate - the delegate to use for notifications

ClearUnregisterPlayerCompleteDelegate[edit]

function ClearUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerCompleteUnregisterPlayerCompleteDelegate)

Overrides: OnlineGameInterfaceImpl.ClearUnregisterPlayerCompleteDelegate

Specified by: OnlineGameInterface.ClearUnregisterPlayerCompleteDelegate

Removes the specified delegate from the notification list

Parameters:

  • UnregisterPlayerCompleteDelegate - the delegate to use for notifications