UE3:OnlineSubsystemLive properties (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

;Other member categories for this class::

Properties

AllLoginDelegates

Type: LoginDelegates

Holds the list of delegates to fire when any login changes

AnyContentChangeDelegates

Type: array<delegate<OnContentChange> >

The list of delegates to notify when any content changes

ArbitrationList

Type: array<OnlineSubsystem.OnlineArbitrationRegistrant>

Last set registrants in an arbitration registration

ArbitrationRegistrationCompleteDelegates

Type: array<delegate<OnArbitrationRegistrationComplete> >

Array of delegates to multicast with for arbitration registration notification

AsyncTasks

Type: array<pointer{FOnlineAsyncTaskLive}>

Modifiers: native, const

This is the array of pending async tasks. Each tick these tasks are checked completion. If complete, the delegate associated with them is called

bIsInSignInUI

Type: bool

Modifiers: const

Used to track when a user cancels a sign-in request so that code waiting for a result can continue

bShouldLogArbitrationData

Type: bool

Modifiers: config

Whether to log arbitration data or not

bShouldLogStatsData

Type: bool

Modifiers: config

Whether to log stats (including true skill) data or not

bSkillUpdateInProgress

Type: bool

Tracks whether a skill update is asynchronously processing

bWasKeyboardInputCanceled

Type: byte

Whether the user canceled keyboard input or not

CancelFindOnlineGamesCompleteDelegates

Type: array<delegate<OnCancelFindOnlineGamesComplete> >

Array of delegates to multicast with for game search cancellation notification

ConnectionStatusChangeDelegates

Type: array<delegate<OnConnectionStatusChange> >

This is the list of delegates requesting notification Live's connection state changes

ContentCache

Type: ContentListCache

Array size: 4

Cache of content list per player

ControllerChangeDelegates

Type: array<delegate<OnControllerChange> >

This is the list of delegates requesting notification when a controller's state changes

CreateOnlineGameCompleteDelegates

Type: array<delegate<OnCreateOnlineGameComplete> >

Array of delegates to multicast with for game creation notification

CurrentGameState

Type: OnlineSubsystem.EOnlineGameState

Modifiers: const

The current game state as the Live layer understands it

CurrentNotificationPosition

Type: OnlineSubsystem.ENetworkNotificationPosition

Where Live notifications will be displayed on the screen

CurrentStatsRead

Type: OnlineStatsRead

Modifiers: const

The currently outstanding stats read request

DestroyOnlineGameCompleteDelegates

Type: array<delegate<OnDestroyOnlineGameComplete> >

Array of delegates to multicast with for game destruction notification

DeviceCache

Type: DeviceIdCache

Array size: 4

Holds the last results of device selection

EndOnlineGameCompleteDelegates

Type: array<delegate<OnEndOnlineGameComplete> >

Array of delegates to multicast with for game ending notification

ExternalUIChangeDelegates

Type: array<delegate<OnExternalUIChange> >

This is the list of delegates requesting notification when a Live UI opens/closes

FindOnlineGamesCompleteDelegates

Type: array<delegate<OnFindOnlineGamesComplete> >

Array of delegates to multicast with for game search notification

FlushOnlineStatsDelegates

Type: array<delegate<OnFlushOnlineStatsComplete> >

The list of delegates to notify when the stats flush is complete

FriendsCache

Type: FriendsListCache

Array size: 4

Cache of friends data per player

GameSearch

Type: OnlineGameSearch

Modifiers: const

The current game search object in use

GameSettings

Type: OnlineGameSettings

Modifiers: const

The current game settings object in use

InviteCache

Type: InviteData

Array size: 4

The cached data for the players

JoinFriendGameCompleteDelegates

Type: array<delegate<OnJoinFriendGameComplete> >

Holds the list of delegates that are interested in receiving join friend completions

JoinOnlineGameCompleteDelegates

Type: array<delegate<OnJoinOnlineGameComplete> >

Array of delegates to multicast with for game join notification

KeyboardInputDelegates

Type: array<delegate<OnKeyboardInputComplete> >

The list of delegates to notify when the keyboard input is complete

KeyboardInputResults

Type: string

Holds the last keyboard input results

LanAnnouncePort

Type: int

Modifiers: const, config

Port to listen on for LAN queries/responses

Default value: 14001

LanBeacon

Type: pointer{FLanBeacon}

Modifiers: const, native, transient

LAN announcement socket used to send/receive discovery packets

LanBeaconState

Type: OnlineSubsystem.ELanBeaconState

Modifiers: const

The current state the lan beacon is in

LanGameUniqueId

Type: int

Modifiers: const, config

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

LanNonce

Type: byte

Array size: 8

Modifiers: const

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

LanPacketPlatformMask

Type: int

Modifiers: const, config

Mask containing which platforms can cross communicate

LanQueryTimeLeft

Type: float

The amount of time before the lan query is considered done

LanQueryTimeout

Type: float

Modifiers: config

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

LastInputDeviceConnectedMask

Type: int

Holds a true/false connection state for each of the possible 4 controllers

LastSignInMask

Type: int

Modifiers: const

Used to compare previous sign in masks to handle players signing out

LastXuids

Type: OnlineSubsystem.UniqueNetId

Array size: 4

Modifiers: const

The set of last known xuids

LinkStatusChangeDelegates

Type: array<delegate<OnConnectionStatusChange> >

This is the list of delegates requesting notification of link status changes

ListPlayInfo

Type: pointer{FListPlayInfo}

Modifiers: const, native, transient

Holds the secure key information for a list play session

ListPlayReadSize

Type: int

Modifiers: config

The number of list play servers to read in one request

LiveSystemLinkPort

Type: int

Modifiers: const, config

The port to tell Live to send/receive all broadcasts on

Default value: 14000

LocalTalkers

Type: OnlineSubsystem.LocalTalker

Array size: 4

Holds information about each of the local talkers

LoginCancelledDelegates

Type: array<delegate<OnLoginCancelled> >

This is the list of requested delegates to fire when a login is cancelled

LoginFailedDelegates

Type: array<delegate<OnLoginFailed> >

This is the list of requested delegates to fire when a login fails to process

LogoutCompletedDelegates

Type: array<delegate<OnLogoutCompleted> >

This is the list of requested delegates to fire when a logout completes

MaxListPlayServersToRead

Type: int

Modifiers: config

The maximum number of list play servers to read before stopping

MutingChangeDelegates

Type: array<delegate<OnMutingChange> >

Holds the list of delegates that are interested in receiving mute change notifications

NotificationHandle

Type: pointer{void}

Modifiers: const, native, transient

The notification handle to use for polling events

NumLogins

Type: int

Modifiers: const, config

The number of simultaneous logins allowed (1, 2, or 4)

PerUserDelegates

Type: PerUserDelegateLists

Array size: 4

Per user array of array of delegates

PlayerLoginDelegates

Type: LoginDelegates

Array size: 4

Used for per player index notification of sign in changes

ProfileCache

Type: ProfileSettingsCache

Array size: 4

Holds the per player profile data

QoSPacket

Type: byte

Array size: 512

Modifiers: const

QoS packet with extra data to send to client

ReadOnlineStatsCompleteDelegates

Type: array<delegate<OnReadOnlineStatsComplete> >

This is the list of delegates requesting notification when a stats read finishes

RegisterPlayerCompleteDelegates

Type: array<delegate<OnRegisterPlayerComplete> >

Array of delegates to multicast with for player registration notification

RemoteTalkers

Type: array<LiveRemoteTalker>

Array of registered remote talkers

SessionInfo

Type: pointer{FSecureSessionInfo}

Modifiers: const, native, transient

The session information of the current session

StartOnlineGameCompleteDelegates

Type: array<delegate<OnStartOnlineGameComplete> >

Array of delegates to multicast with for game starting notification

StorageDeviceChangeDelegates

Type: array<delegate<OnStorageDeviceChange> >

This is the list of delegates requesting notification of storage device changes

TalkingDelegates

Type: array<delegate<OnPlayerTalking> >

Holds the list of delegates that are interested in receiving talking notifications

UnregisterPlayerCompleteDelegates

Type: array<delegate<OnUnregisterPlayerComplete> >

Array of delegates to multicast with for player unregistration notification

XLocatorServiceHandle

Type: pointer{void}

Modifiers: const, native, transient

The handle used with the XLocator service