I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:OnlineSystemInterface (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

OnConnectionStatusChange[edit]

delegate OnConnectionStatusChange (OnlineSubsystem.EOnlineServerConnectionStatus ConnectionStatus)

Delegate fire when the online server connection state changes

Parameters:

  • ConnectionStatus - the new connection status

OnControllerChange[edit]

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

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

delegate OnLinkStatusChange (bool bIsConnected)

Delegate fired when the network link status changes

Parameters:

  • bIsConnected - whether the link is currently connected or not

OnReadTitleFileComplete[edit]

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

delegate OnStorageDeviceChange ()

Delegate fired when a storage device change is detected

Instance functions[edit]

AddConnectionStatusChangeDelegate[edit]

function AddConnectionStatusChangeDelegate (delegate<OnConnectionStatusChangeConnectionStatusDelegate)

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

Parameters:

  • ConnectionStatusDelegate - the delegate to add

AddControllerChangeDelegate[edit]

function AddControllerChangeDelegate (delegate<OnControllerChangeControllerChangeDelegate)

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

Parameters:

  • ControllerChangeDelegate - the delegate to use for notifications

AddExternalUIChangeDelegate[edit]

function AddExternalUIChangeDelegate (delegate<OnExternalUIChangeExternalUIDelegate)

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

function AddLinkStatusChangeDelegate (delegate<OnLinkStatusChangeLinkStatusDelegate)

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

Parameters:

  • LinkStatusDelegate - the delegate to use for notifications

AddReadTitleFileCompleteDelegate[edit]

function AddReadTitleFileCompleteDelegate (delegate<OnReadTitleFileCompleteReadTitleFileCompleteDelegate)

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

Parameters:

  • ReadTitleFileCompleteDelegate - the delegate to add

AddStorageDeviceChangeDelegate[edit]

function AddStorageDeviceChangeDelegate (delegate<OnStorageDeviceChangeStorageDeviceChangeDelegate)

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

Parameters:

  • StorageDeviceChangeDelegate - the delegate to add

ClearConnectionStatusChangeDelegate[edit]

function ClearConnectionStatusChangeDelegate (delegate<OnConnectionStatusChangeConnectionStatusDelegate)

Removes the delegate from the notify list

Parameters:

  • ConnectionStatusDelegate - the delegate to remove

ClearControllerChangeDelegate[edit]

function ClearControllerChangeDelegate (delegate<OnControllerChangeControllerChangeDelegate)

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

Parameters:

  • ControllerChangeDelegate - the delegate to remove

ClearExternalUIChangeDelegate[edit]

function ClearExternalUIChangeDelegate (delegate<OnExternalUIChangeExternalUIDelegate)

Removes the delegate from the notification list

Parameters:

  • ExternalUIDelegate - the delegate to remove

ClearLinkStatusChangeDelegate[edit]

function ClearLinkStatusChangeDelegate (delegate<OnLinkStatusChangeLinkStatusDelegate)

Removes the delegate from the notify list

Parameters:

  • LinkStatusDelegate - the delegate to remove

ClearReadTitleFileCompleteDelegate[edit]

function ClearReadTitleFileCompleteDelegate (delegate<OnReadTitleFileCompleteReadTitleFileCompleteDelegate)

Removes the delegate from the notify list

Parameters:

  • ReadTitleFileCompleteDelegate - the delegate to remove

ClearStorageDeviceChangeDelegate[edit]

function ClearStorageDeviceChangeDelegate (delegate<OnStorageDeviceChangeStorageDeviceChangeDelegate)

Removes the delegate from the notify list

Parameters:

  • StorageDeviceChangeDelegate - the delegate to remove

GetNATType[edit]

function OnlineSubsystem.ENATType GetNATType ()

Determines the NAT type the player is using

GetNetworkNotificationPosition[edit]

function OnlineSubsystem.ENetworkNotificationPosition GetNetworkNotificationPosition ()

Determines the current notification position setting

GetTitleFileContents[edit]

function bool GetTitleFileContents (string FileName, out array<byteFileContents)

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

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

function bool HasLinkConnection ()

Determines if the ethernet link is connected or not

IsControllerConnected[edit]

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

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

function SetNetworkNotificationPosition (OnlineSubsystem.ENetworkNotificationPosition NewPos)

Sets a new position for the network notification icons/images

Parameters:

  • NewPos - the new location to use