Engine.OnlineSubsystem

Extends

Object

Modifiers

native abstract inherits ( FTickableObject ) dependson ( Settings ) config ( Engine )

This class holds a set of online interfaces that game code uses to talk with the platform layer's services. The set of services are implemented as interface pointers so that we can mix & match services at run time. This also allows licensees the ability to use part of our base services and provide custom implmentations of others.

Core.Object
|   
+-- Engine.OnlineSubsystem

Direct Known Subclasses:

OnlineSubsystemCommonImpl

Functions Summary
		DumpGameSettings (const OnlineGameSettings GameSettings))
		DumpNetIds (const out array<UniqueNetId> Players, string DebugLabel))
		DumpSessionState ()))
		DumpVoiceRegistration ()
		Exit ()
	int	GetBuildUniqueId ()
	Object	GetNamedInterface (name InterfaceName))
	int	GetNumSupportedLogins ()
	bool	Init ()
	bool	PostInit ()))
	bool	SetAccountInterface (Object NewInterface))
	bool	SetContentInterface (Object NewInterface))
		SetDebugSpewLevel (int DebugSpewLevel)
	bool	SetGameInterface (Object NewInterface))
		SetNamedInterface (name InterfaceName, bject NewInterface))
	bool	SetNewsInterface (Object NewInterface))
	bool	SetPartyChatInterface (Object NewInterface))
	bool	SetPlayerInterface (Object NewInterface))
	bool	SetPlayerInterfaceEx (Object NewInterface))
	bool	SetStatsInterface (Object NewInterface))
	bool	SetSystemInterface (Object NewInterface))
	bool	SetTitleFileInterface (Object NewInterface))
	bool	SetVoiceInterface (Object NewInterface))
	bool	StringToUniqueNetId (string UniqueNetIdString, ut UniqueNetId out_UniqueId)
	string	UniqueNetIdToString (const out UniqueNetId IdToConvert)

AccountInterface Source code

The interface to use for creating and/or enumerating account information

AsyncMinCompletionTime Source code

Used to introduce latency when communicating with the online layer for testing purposes

BuildIdOverride Source code

Used to specify a build override value

bUseBuildIdOverride Source code

Whether to use the override or not

ContentInterface Source code

The interface to use for online content

GameInterface Source code

The interface to use for creating, searching for, or destroying online games

IniLocPatcherClassName Source code

The class to create our patcher instance from

NamedInterfaceDefs Source code

The list of named interfaces to automatically create and store

NamedInterfaces Source code

Holds the set of registered named interfaces

NewsInterface Source code

The interface to use for reading game specific news announcements

PartyChatInterface Source code

The interface to use for accessing online party chat methods

Patcher Source code

The object responsible for patching downloaded INI/loc files

PlayerInterface Source code

The interface for accessing online player methods

PlayerInterfaceEx Source code

The interface for accessing online player extension methods

Sessions Source code

The list of sessions currently managed by the online subsystem

StatsInterface Source code

The interface to use for stats read/write operations

SystemInterface Source code

The interface for accessing system wide network functions

TitleFileInterface Source code

The interface to use for downloading files from the network platform

VoiceInterface Source code

The interface to use for voice communication

EFeaturePrivilegeLevel Source code

This enum indicates access to major features in the game (parent controls

ELanBeaconState Source code

Indicates the state the LAN beacon is in

ELoginStatus Source code

The different login statuses for a player

ENATType Source code

The various NAT types the player may have

ENetworkNotificationPosition Source code

Indicates where network notifications should appear on the screen

EOnlineAccountCreateStatus Source code

The series of status codes that the account creation method can return

EOnlineContentType Source code

The type of player owned content

EOnlineEnumerationReadState Source code

The state of an async enumeration (friends, content, etc) read request

EOnlineFriendState Source code

The possible friend states for a friend entry

EOnlineGameState Source code

Enum indicating the current state of the online game (in progress, ended, etc.)

EOnlineNewsType Source code

The state of an async enumeration (friends, content, etc) read request

EOnlineServerConnectionStatus Source code

Indicates the connection status with the remote online servers

AchievementDetails Source code

Holds the information contained in Live's achievements for this title
AchievementName:

The name of the achievement

bIsSecret:

Whether the achievement is secret (hidden if not achieved) or not

bWasAchievedOffline:

Whether the achievement awarded offline or not

bWasAchievedOnline:

Whether the achievement awarded online or not

Description:

The description of the achievement

GamerPoints:

How much this achievement is worth

HowTo:

The description of how to meet the requirements of the achievement

Id:

The ID of the achievement

Image:

The image associated with the achievement

CommunityContentFile Source code

Community file info
AverageRating:

The average rating for this file from the community

ContentId:

Unique identifier for this content file

ContentType:

Game specific content type field

DownloadCount:

The number of times this file has been downloaded

FileId:

Additional identifier for providers that need it

FileSize:

Size in bytes of the payload in the file

LastRatingGiven:

The last rating the user gave this content

LocalFilePath:

The path to the file if stored locally

Owner:

The original owner of the file

RatingCount:

The number of times this file has been rated

CommunityContentMetadata Source code

Community file metadata
ContentType:

Unique identifier for this content type

MetadataItems:

Metadata to associate with the file

FriendsQuery Source code

Used to bulk query the friends list
bIsFriend:

Out param indicating whether the player is a friend or not

UniqueId:

The unique player id to check friends status for

LocalTalker Source code

Information about a local talker
bHasNetworkedVoice:

Whether the talker should send network data

bHasVoice:

Whether this talker is currently registered

bIsRecognizingSpeech:

Whether the player is trying to speak voice commands

bIsRegistered:

Whether this player was already registered with the voice interface or not

bIsTalking:

Whether the remote talker is speaking this frame

bWasTalking:

Whether the local talker was speaking last frame

NamedInterface Source code

Holds a named object interface for dynamically bound interfaces
InterfaceName:

The name to bind this object to

InterfaceObject:

The object to store at this location

NamedInterfaceDef Source code

Holds a name to class name mapping for adding the named interfaces automatically
InterfaceClassName:

The class to load and create for the named interface

InterfaceName:

The name to bind this object to

NamedSession Source code

Holds the per session information for named sessions
ArbitrationRegistrants:

The set of registered players for arbitration

GameSettings:

The game settings associated with this session

Registrants:

List of players registered in the session

SessionInfo:

The platform specific session information

SessionName:

The name of the session

OnlineArbitrationRegistrant Source code

Struct holding the information about a single arbitration registrant
MachineId:

Unique id of the machine involved in the arbitrated session

Trustworthiness:

Trust level of the machine/player for the arbitrated session

OnlineContent Source code

Holds information about a single piece of downloaded content
ContentFiles:

List of all non-package files in the content

ContentPackages:

List of packages in the content

ContentPath:

File system usable reference to the content

ContentType:

The type of content this represents

DeviceId:

The device ID the DLC is on

Filename:

Non-displayable file name of the content

FriendlyName:

Displayable name of the content

UserIndex:

Optional user index that content is downloaded for (-1 means it's not associated with any user)

OnlineFriend Source code

Holds information about a player in a friends list
bHasInvitedYou:

Whether the friends has sent an invite to you or not

bHasVoiceSupport:

Whether the friend can chat via voice or not

bHaveInvited:

Whether the friends has an invitation outstanding from you or not

bIsJoinable:

Whether the game the friend is in is joinable or not

bIsOnline:

Whether the friend is online or not

bIsPlaying:

Whether the friend is playing a game or not

bIsPlayingThisGame:

Whether the friend is playing the same game or not

FriendState:

The current state for this friend

NickName:

Player's nick as published to the online service

PresenceInfo:

String holding information about the player's game state (cap-ed flag, etc.)

SessionId:

The session id that the player is in

UniqueId:

Unique identifier of the friend

OnlineFriendMessage Source code

Holds the data used in a friend message
bIsFriendInvite:

Whether this is a friend invite or just a generic message

bIsGameInvite:

Whether this message is a game invite or not

bWasAccepted:

Whether the invite has been accepted or not

bWasDenied:

Whether the invite has been denied or not

Message:

The corresponding message that was sent

SendingPlayerId:

The player that is sending the message

SendingPlayerNick:

The nick name of the player that sent the message

OnlinePartyMember Source code

Holds information about a player in a friends list
bIsInGameSession:

Whether the player is in a game session

bIsInPartyVoice:

Whether the player is in party voice or game voice

bIsLocal:

Whether the player is local to this machine or remote

bIsPlayingThisGame:

Whether the party member is playing the same game or not

bIsTalking:

Whether the player is talking or not

Data1:

The first 4 bytes of custom application data

Data2:

The second 4 bytes of custom application data

Data3:

The third 4 bytes of custom application data

Data4:

The fourth 4 bytes of custom application data

LocalUserNum:

The local controller id if local

NatType:

The NAT type for this player

Nickname:

The player's nickname

SessionId:

The session id that the player is in

TitleId:

The title id of the title the player is in

UniqueId:

Unique identifier of the friend

OnlinePlayerScore Source code

Struct holding information used when writing scoring information that is used to determine a player's skill rating
PlayerId:

The player that this score is for

Score:

The score for this player

TeamId:

The team that the player is on

OnlineRegistrant Source code

A player in a session
PlayerNetId:

Unique id of the player involved in the arbitrated session

RemoteTalker Source code

Information about a remote talker
bIsRegistered:

Whether this player was already registered with the voice interface or not

bIsTalking:

Whether the remote talker is speaking this frame

bWasTalking:

Whether the remote talker was speaking last frame

LastNotificationTime:

Used to trigger talking delegates only after a certain period of time has passed

TalkerId:

The unique id for this talker

SpeechRecognizedWord Source code

Holds a word/phrase that was recognized by the speech analyzer @note See VoiceInterface.h to change the native layout of this struct
Confidence:

How confident the analyzer was in the recognition

WordId:

The id of the word in the vocabulary

WordText:

the actual word

TitleFile Source code

Holds the data used in downloading a file asynchronously from the online service
AsyncState:

The async state the file download is in

Data:

The buffer of data for the file

Filename:

The name of the file as requested

UniqueNetId Source code

Struct that holds a transient, unique identifier for a player
Uid:

The id used by the network to uniquely identify a player

DumpGameSettings Source code

Logs the game settings object
@param GameSettings settings to dump

DumpNetIds Source code

Log list of players' netids for debugging

DumpSessionState Source code

Logs the session state for all sessions present

DumpVoiceRegistration Source code

Logs the list of players that are registered for voice

Exit Source code

Called from the engine shutdown code to allow the subsystem to release any resources that may have been allocated

GetBuildUniqueId Source code

Generates a unique number based off of the current script compilation
@return the unique number from the current script compilation

GetNamedInterface Source code

Returns the interface object associated with the specified name
@param InterfaceName the name of the interface to retrieve
@return The object that matches the interface name if found

GetNumSupportedLogins Source code

Returns the number of players that can be signed in on this platform

Init Source code

Called from engine start up code to allow the subsystem to initialize
@return TRUE if the initialization was successful, FALSE otherwise

PostInit Source code

Used to trigger any automated tasks that need to happen just after startup

SetAccountInterface Source code

Called from native code to assign the account interface
@param NewInterface the object to assign as providing the account interface
@return TRUE if the interface is valid, FALSE otherwise

SetContentInterface Source code

Called from native code to assign the content interface
@param NewInterface the object to assign as providing the content interface
@return TRUE if the interface is valid, FALSE otherwise

SetDebugSpewLevel Source code

Sets the debug output level for the platform specific API (if applicable)
@param DebugSpewLevel the level to set

SetGameInterface Source code

Called from native code to assign the game interface
@param NewInterface the object to assign as providing the game interface
@return TRUE if the interface is valid, FALSE otherwise

SetNamedInterface Source code

Adds the interface object to the named interface list with the specified name
@param InterfaceName the name of the interface to add it as
@param NewInterface the object/interface that is being cached

SetNewsInterface Source code

Called from native code to assign the news interface
@param NewInterface the object to assign as providing the news interface
@return TRUE if the interface is valid, FALSE otherwise

SetPartyChatInterface Source code

Called from native code to assign the party chat interface
@param NewInterface the object to assign as providing the party chat interface
@return TRUE if the interface is valid, FALSE otherwise

SetPlayerInterface Source code

Called from native code to assign the player interface
@param NewInterface the object to assign as providing the player interface
@return TRUE if the interface is valid, FALSE otherwise

SetPlayerInterfaceEx Source code

Called from native code to assign the extended player interface
@param NewInterface the object to assign as providing the player interface
@return TRUE if the interface is valid, FALSE otherwise

SetStatsInterface Source code

Called from native code to assign the stats interface
@param NewInterface the object to assign as providing the stats interface
@return TRUE if the interface is valid, FALSE otherwise

SetSystemInterface Source code

Called from native code to assign the system interface
@param NewInterface the object to assign as providing the system interface
@return TRUE if the interface is valid, FALSE otherwise

SetTitleFileInterface Source code

Called from native code to assign the title file interface
@param NewInterface the object to assign as providing the file downloading interface
@return TRUE if the interface is valid, FALSE otherwise

SetVoiceInterface Source code

Called from native code to assign the voice interface
@param NewInterface the object to assign as providing the voice interface
@return TRUE if the interface is valid, FALSE otherwise

StringToUniqueNetId Source code

Converts a string representing a UniqueNetId into a UniqueNetId struct.
@param UniqueNetIdString the string containing the text representation of the unique id.
@param out_UniqueId will receive the UniqueNetId generated from the string.
@return TRUE if the string was successfully converted into a UniqueNetId; FALSE if the string was not a valid UniqueNetId.

UniqueNetIdToString Source code

Generates a string representation of a UniqueNetId struct.
@param IdToConvert the unique net id that should be converted to a string.
@return the specified UniqueNetId represented as a string.