UE3:OnlineSystemInterface (UDK)

Interface >> OnlineSystemInterface

Package: 

Engine

Known implementing classes:

OnlineSubsystemPC

This interface in other games:

UT3

This interface provides accessors to the platform specific system methods, features that do not pertain to a single user but to the game as a whole.

Delegates

OnConnectionStatusChange

delegate OnConnectionStatusChange (OnlineSubsystem.EOnlineServerConnectionStatus ConnectionStatus)

Delegate fire when the online server connection state changes

Parameters:

• ConnectionStatus - the new connection status

OnControllerChange

delegate OnControllerChange (int ControllerId, bool bIsConnected)

Delegate fired when the controller becomes dis/connected

Parameters:

• ControllerId - the id of the controller that changed connection state
• bIsConnected - whether the controller connected (true) or disconnected (false)

OnExternalUIChange

delegate OnExternalUIChange (bool bIsOpening)

Delegate fired when an external UI display state changes (opening/closing)

Parameters:

• bIsOpening - whether the external UI is opening or closing

OnLinkStatusChange

delegate OnLinkStatusChange (bool bIsConnected)

Delegate fired when the network link status changes

Parameters:

• bIsConnected - whether the link is currently connected or not

OnReadTitleFileComplete

delegate OnReadTitleFileComplete (bool bWasSuccessful, string FileName)

Delegate fired when a file read from the network platform's title specific storage is complete

Parameters:

• bWasSuccessful - whether the file read was successful or not
• FileName - the name of the file this was for

OnStorageDeviceChange

delegate OnStorageDeviceChange ()

Delegate fired when a storage device change is detected

Instance functions

AddConnectionStatusChangeDelegate

function AddConnectionStatusChangeDelegate (delegate<OnConnectionStatusChange> ConnectionStatusDelegate)

Adds the delegate to the list to be notified when the connection status changes

Parameters:

• ConnectionStatusDelegate - the delegate to add

AddControllerChangeDelegate

function AddControllerChangeDelegate (delegate<OnControllerChange> ControllerChangeDelegate)

Sets the delegate used to notify the gameplay code that the controller state changed

Parameters:

• ControllerChangeDelegate - the delegate to use for notifications

AddExternalUIChangeDelegate

function AddExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)

Sets the delegate used to notify the gameplay code that external UI state changed (opened/closed)

Parameters:

• ExternalUIDelegate - the delegate to use for notifications

AddLinkStatusChangeDelegate

function AddLinkStatusChangeDelegate (delegate<OnLinkStatusChange> LinkStatusDelegate)

Adds the delegate used to notify the gameplay code that link status changed

Parameters:

• LinkStatusDelegate - the delegate to use for notifications

AddReadTitleFileCompleteDelegate

function AddReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)

Adds the delegate to the list to be notified when a requested file has been read

Parameters:

• ReadTitleFileCompleteDelegate - the delegate to add

AddStorageDeviceChangeDelegate

function AddStorageDeviceChangeDelegate (delegate<OnStorageDeviceChange> StorageDeviceChangeDelegate)

Adds the delegate to the list to be notified when a storage device changes

Parameters:

• StorageDeviceChangeDelegate - the delegate to add

ClearConnectionStatusChangeDelegate

function ClearConnectionStatusChangeDelegate (delegate<OnConnectionStatusChange> ConnectionStatusDelegate)

Removes the delegate from the notify list

Parameters:

• ConnectionStatusDelegate - the delegate to remove

ClearControllerChangeDelegate

function ClearControllerChangeDelegate (delegate<OnControllerChange> ControllerChangeDelegate)

Removes the delegate used to notify the gameplay code that the controller state changed

Parameters:

• ControllerChangeDelegate - the delegate to remove

ClearExternalUIChangeDelegate

function ClearExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)

Removes the delegate from the notification list

Parameters:

• ExternalUIDelegate - the delegate to remove

ClearLinkStatusChangeDelegate

function ClearLinkStatusChangeDelegate (delegate<OnLinkStatusChange> LinkStatusDelegate)

Removes the delegate from the notify list

Parameters:

• LinkStatusDelegate - the delegate to remove

ClearReadTitleFileCompleteDelegate

function ClearReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)

Removes the delegate from the notify list

Parameters:

• ReadTitleFileCompleteDelegate - the delegate to remove

ClearStorageDeviceChangeDelegate

function ClearStorageDeviceChangeDelegate (delegate<OnStorageDeviceChange> StorageDeviceChangeDelegate)

Removes the delegate from the notify list

Parameters:

• StorageDeviceChangeDelegate - the delegate to remove

GetNATType

function OnlineSubsystem.ENATType GetNATType ()

Determines the NAT type the player is using

GetNetworkNotificationPosition

function OnlineSubsystem.ENetworkNotificationPosition GetNetworkNotificationPosition ()

Determines the current notification position setting

GetTitleFileContents

function bool GetTitleFileContents (string FileName, out array<byte> FileContents)

Copies the file data into the specified buffer for the specified file

Parameters:

• FileName - the name of the file to read
• FileContents - the out buffer to copy the data into

Returns:

true if the data was copied, false otherwise

GetTitleFileState

function OnlineSubsystem.EOnlineEnumerationReadState GetTitleFileState (string FileName)

Determines the async state of the tile file read operation

Parameters:

• FileName - the name of the file to check on

Returns:

the async state of the file read

HasLinkConnection

function bool HasLinkConnection ()

Determines if the ethernet link is connected or not

IsControllerConnected

function bool IsControllerConnected (int ControllerId)

Determines if the specified controller is connected or not

Parameters:

• ControllerId - the controller to query

Returns:

true if connected, false otherwise

ReadTitleFile

function bool ReadTitleFile (string FileToRead)

Starts an asynchronous read of the specified file from the network platform's title specific file store

Parameters:

• FileToRead - the name of the file to read

Returns:

true if the calls starts successfully, false otherwise

SetNetworkNotificationPosition

function SetNetworkNotificationPosition (OnlineSubsystem.ENetworkNotificationPosition NewPos)

Sets a new position for the network notification icons/images

Parameters:

• NewPos - the new location to use