Gah - a solution with more questions. – EntropicLqd

From Unreal Wiki, The Unreal Engine Documentation Site

Object >> OnlineGameInterfaceImpl

Package: 

IpDrv

Within class: 

OnlineSubsystemCommonImpl

Implemented interfaces: 

OnlineGameInterface

Direct subclass:

OnlineGameInterfaceGameSpy

This class in other games:

UDK

Class that implements a cross platform version of the game interface

[edit] Properties

[edit] CancelFindOnlineGamesCompleteDelegates

Type: array<delegate<OnCancelFindOnlineGamesComplete> >

Array of delegates to multicast with for game search notification

[edit] CreateOnlineGameCompleteDelegates

Type: array<delegate<OnCreateOnlineGameComplete> >

Array of delegates to multicast with for game creation notification

[edit] CurrentGameState

Type: OnlineSubsystem.EOnlineGameState

Modifiers: const

The current game state as the Live layer understands it

[edit] DestroyOnlineGameCompleteDelegates

Type: array<delegate<OnDestroyOnlineGameComplete> >

Array of delegates to multicast with for game destruction notification

[edit] EndOnlineGameCompleteDelegates

Type: array<delegate<OnEndOnlineGameComplete> >

Array of delegates to multicast with for game ending notification

[edit] FindOnlineGamesCompleteDelegates

Type: array<delegate<OnFindOnlineGamesComplete> >

Array of delegates to multicast with for game search notification

[edit] GameSearch

Type: OnlineGameSearch

Modifiers: const

The current game search object in use

[edit] GameSettings

Type: OnlineGameSettings

Modifiers: const

The current game settings object in use

[edit] JoinOnlineGameCompleteDelegates

Type: array<delegate<OnJoinOnlineGameComplete> >

Array of delegates to multicast with for game join notification

[edit] LanAnnouncePort

Type: int

Modifiers: const, config

Port to listen on for LAN queries/responses

Default value: 14001

[edit] LanBeacon

Type: pointer{FLanBeacon}

Modifiers: const, native, transient

LAN announcement socket used to send/receive discovery packets

[edit] LanBeaconState

Type: OnlineSubsystem.ELanBeaconState

Modifiers: const

The current state the lan beacon is in

[edit] LanGameUniqueId

Type: int

Modifiers: const, config

Unique id to keep UE3 games from seeing each others' lan packets

Default value: 1297549275

[edit] LanNonce

Type: byte

Array size: 8

Modifiers: const

Used by a client to uniquely identify itself during lan match discovery

[edit] LanPacketPlatformMask

Type: int

Modifiers: const, config

Mask containing which platforms can cross communicate

Default value: 1

[edit] LanQueryTimeLeft

Type: float

The amount of time before the lan query is considered done

[edit] LanQueryTimeout

Type: float

Modifiers: config

The amount of time to wait before timing out a lan query request

Default value: 5.0

[edit] OwningSubsystem

Type: OnlineSubsystemCommonImpl

The owning subsystem that this object is providing an implementation for

[edit] SessionInfo

Type: pointer{FSessionInfo}

Modifiers: native, const, transient, private

The session information used to connect to a host

[edit] StartOnlineGameCompleteDelegates

Type: array<delegate<OnStartOnlineGameComplete> >

Array of delegates to multicast with for game starting notification

[edit] Delegates

[edit] OnArbitrationRegistrationComplete

Specified by: OnlineGameInterface.OnArbitrationRegistrationComplete

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

[edit] OnCancelFindOnlineGamesComplete

Specified by: OnlineGameInterface.OnCancelFindOnlineGamesComplete

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

[edit] OnCreateOnlineGameComplete

Specified by: OnlineGameInterface.OnCreateOnlineGameComplete

Delegate fired when a create request has completed

Parameters:

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

[edit] OnDestroyOnlineGameComplete

Specified by: OnlineGameInterface.OnDestroyOnlineGameComplete

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

[edit] OnEndOnlineGameComplete

Specified by: OnlineGameInterface.OnEndOnlineGameComplete

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

[edit] OnFindOnlineGamesComplete

Specified by: OnlineGameInterface.OnFindOnlineGamesComplete

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

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

[edit] OnJoinOnlineGameComplete

Specified by: OnlineGameInterface.OnJoinOnlineGameComplete

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

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

[edit] OnStartOnlineGameComplete

Specified by: OnlineGameInterface.OnStartOnlineGameComplete

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

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

[edit] Functions

[edit] Native functions

[edit] CancelFindOnlineGames

Specified by: OnlineGameInterface.CancelFindOnlineGames

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

Returns:

true if successful searching for sessions, false otherwise

[edit] CreateOnlineGame

Specified by: OnlineGameInterface.CreateOnlineGame

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

[edit] DestroyOnlineGame

Specified by: OnlineGameInterface.DestroyOnlineGame

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

[edit] EndOnlineGame

Specified by: OnlineGameInterface.EndOnlineGame

Marks an online game as having been ended

Returns:

true if the call succeeds, false otherwise

[edit] FindOnlineGames

Specified by: OnlineGameInterface.FindOnlineGames

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

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

[edit] GetResolvedConnectString

Specified by: OnlineGameInterface.GetResolvedConnectString

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

[edit] JoinOnlineGame

Specified by: OnlineGameInterface.JoinOnlineGame

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

[edit] StartOnlineGame

Specified by: OnlineGameInterface.StartOnlineGame

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

Returns:

true if the call succeeds, false otherwise

[edit] Other instance functions

See OnlineGameInterfaceImpl instance functions.