My program doesn't have bugs. It just develops random features.

UE3:OnlineSystemInterface (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Interface >> OnlineSystemInterface

Contents
Package: 
Engine
Known implementing classes:
OnlineSubsystemGameSpy, OnlineSubsystemLive
This interface in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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.

[edit] Delegates

[edit] OnConnectionStatusChange

delegate OnConnectionStatusChange (OnlineSubsystem.EOnlineServerConnectionStatus ConnectionStatus)

Delegate fire when the online server connection state changes

Parameters:

  • ConnectionStatus - the new connection status

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

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

[edit] OnLinkStatusChange

delegate OnLinkStatusChange (bool bIsConnected)

Delegate fired when the network link status changes

Parameters:

  • bIsConnected - whether the link is currently connected or not

[edit] OnStorageDeviceChange

delegate OnStorageDeviceChange ()

Delegate fired when a storage device change is detected

[edit] Instance functions

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

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

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

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

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

[edit] ClearConnectionStatusChangeDelegate

function ClearConnectionStatusChangeDelegate (delegate<OnConnectionStatusChange> ConnectionStatusDelegate)

Removes the delegate from the notify list

Parameters:

  • ConnectionStatusDelegate - the delegate to remove

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

[edit] ClearExternalUIChangeDelegate

function ClearExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)

Removes the delegate from the notification list

Parameters:

  • ExternalUIDelegate - the delegate to remove

[edit] ClearLinkStatusChangeDelegate

function ClearLinkStatusChangeDelegate (delegate<OnLinkStatusChange> LinkStatusDelegate)

Removes the delegate from the notify list

Parameters:

  • LinkStatusDelegate - the delegate to remove

[edit] ClearStorageDeviceChangeDelegate

function ClearStorageDeviceChangeDelegate (delegate<OnStorageDeviceChange> StorageDeviceChangeDelegate)

Removes the delegate from the notify list

Parameters:

  • ConnectionStatusDelegate - the delegate to remove

[edit] GetNATType

function OnlineSubsystem.ENATType GetNATType ()

Determines the NAT type the player is using

[edit] GetNetworkNotificationPosition

function OnlineSubsystem.ENetworkNotificationPosition GetNetworkNotificationPosition ()

Determines the current notification position setting

[edit] HasLinkConnection

function bool HasLinkConnection ()

Determines if the ethernet link is connected or not

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

[edit] SetNetworkNotificationPosition

function SetNetworkNotificationPosition (OnlineSubsystem.ENetworkNotificationPosition NewPos)

Sets a new position for the network notification icons/images

Parameters:

  • NewPos - the new location to use
Retrieved from "http://wiki.beyondunreal.com/UE3:OnlineSystemInterface_(UT3)"
Personal tools