Engine.OnlineSubsystem

Extends

Object

Modifiers

native abstract inherits ( FTickableObject )

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
	bool	CanAutoLogin ()
	bool	Init ()
	bool	SetAccountInterface (Object NewInterface))
	bool	SetContentInterface (Object NewInterface))
	bool	SetGameInterface (Object NewInterface))
	bool	SetNewsInterface (Object NewInterface))
	bool	SetPlayerInterface (Object NewInterface))
	bool	SetPlayerInterfaceEx (Object NewInterface))
	bool	SetStatsInterface (Object NewInterface))
	bool	SetSystemInterface (Object NewInterface))
	bool	SetVoiceInterface (Object NewInterface))
	bool	StringToUniqueNetId (string UniqueNetIdString, out UniqueNetId out_UniqueId)
	string	UniqueNetIdToString (const out UniqueNetId IdToConvert)

AccountInterface Source code

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

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

NewsInterface Source code

The interface to use for reading game specific news announcements

PlayerInterface Source code

The interface for accessing online player methods

PlayerInterfaceEx Source code

The interface for accessing online player extension methods

StatsInterface Source code

The interface to use for stats read/write operations

SystemInterface Source code

The interface for accessing system wide network functions

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

EOnlineEnumerationReadState Source code

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

EOnlineGameState Source code

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

EOnlineServerConnectionStatus Source code

Indicates the connection status with the remote online servers

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

bWasTalking:

Whether the local talker was speaking last frame

OnlineArbitrationRegistrant Source code

Struct holding the information about a single arbitration registrant
MachineId:

Unique id of the machine involved in the arbitrated session

PlayerId:

Unique id of the player 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

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
bHasVoiceSupport:

Whether the friend can chat via voice 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

NickName:

Player's nick as published to the online service

PresenceInfo:

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

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

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

RemoteTalker Source code

Information about a remote talker
bWasTalking:

Whether the remote talker was speaking last frame

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

UniqueNetId Source code

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

The id used by the network to uniquely identify a player

CanAutoLogin Source code

Returns true if auto-login credentials are set on the commandline

Init Source code

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

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

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

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

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

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.

defaultproperties
{
   Name="Default__OnlineSubsystem"
   ObjectArchetype=Object'Core.Default__Object'
}