Cogito, ergo sum

UE3:OnlineSystemInterface (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Interface >> OnlineSystemInterface
Package: 
Engine
Known implementing classes:
OnlineSubsystemGameSpy, OnlineSubsystemLive
This interface in other games:
UDK

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

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

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

ClearStorageDeviceChangeDelegate[edit]

function ClearStorageDeviceChangeDelegate (delegate<OnStorageDeviceChangeStorageDeviceChangeDelegate)

Removes the delegate from the notify list

Parameters:

  • ConnectionStatusDelegate - 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

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

SetNetworkNotificationPosition[edit]

function SetNetworkNotificationPosition (OnlineSubsystem.ENetworkNotificationPosition NewPos)

Sets a new position for the network notification icons/images

Parameters:

  • NewPos - the new location to use