The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
UE3:OnlineSubsystem (UT3)
 |
Object >> OnlineSubsystem |
- Package:
- Engine
- Direct subclass:
- OnlineSubsystemCommonImpl
- This class in other games:
- UDK
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
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.
Properties[edit]
AccountInterface[edit]
Type: OnlineAccountInterface
The interface to use for creating and/or enumerating account information
ContentInterface[edit]
Type: OnlineContentInterface
The interface to use for online content
GameInterface[edit]
Type: OnlineGameInterface
The interface to use for creating, searching for, or destroying online games
NewsInterface[edit]
Type: OnlineNewsInterface
The interface to use for reading game specific news announcements
PlayerInterface[edit]
Type: OnlinePlayerInterface
The interface for accessing online player methods
PlayerInterfaceEx[edit]
Type: OnlinePlayerInterfaceEx
The interface for accessing online player extension methods
StatsInterface[edit]
Type: OnlineStatsInterface
The interface to use for stats read/write operations
SystemInterface[edit]
Type: OnlineSystemInterface
The interface for accessing system wide network functions
VoiceInterface[edit]
Type: OnlineVoiceInterface
The interface to use for voice communication
Enums[edit]
Structs[edit]
FriendsQuery[edit]
Modifiers: native
Used to bulk query the friends list
- UniqueNetId UniqueId
- The unique player id to check friends status for
- bool bIsFriend
- Out param indicating whether the player is a friend or not
LocalTalker[edit]
Modifiers: native
Information about a local talker
- bool bHasVoice
- Whether this talker is currently registered
- bool bHasNetworkedVoice
- Whether the talker should send network data
- bool bIsRecognizingSpeech
- Whether the player is trying to speak voice commands
- bool bWasTalking
- Whether the local talker was speaking last frame
OnlineArbitrationRegistrant[edit]
Modifiers: native
Struct holding the information about a single arbitration registrant
- Object.qword MachineId
- Unique id of the machine involved in the arbitrated session
- UniqueNetId PlayerId
- Unique id of the player involved in the arbitrated session
- int Trustworthiness
- Trust level of the machine/player for the arbitrated session
OnlineContent[edit]
Modifiers: native
Holds information about a single piece of downloaded content
- int UserIndex
- Optional user index that content is downloaded for (-1 means it's not associated with any user)
- string FriendlyName
- Displayable name of the content
- string ContentPath
- File system usable reference to the content
- array<string> ContentPackages
- List of packages in the content
- array<string> ContentFiles
- List of all non-package files in the content
OnlineFriend[edit]
Modifiers: native
Holds information about a player in a friends list
- UniqueNetId UniqueId
- Unique identifier of the friend
- string NickName
- Player's nick as published to the online service
- string PresenceInfo
- String holding information about the player's game state (cap-ed flag, etc.)
- bool bIsOnline
- Whether the friend is online or not
- bool bIsPlaying
- Whether the friend is playing a game or not
- bool bIsPlayingThisGame
- Whether the friend is playing the same game or not
- bool bIsJoinable
- Whether the game the friend is in is joinable or not
- bool bHasVoiceSupport
- Whether the friend can chat via voice or not
OnlineFriendMessage[edit]
Modifiers: native
Holds the data used in a friend message
- UniqueNetId SendingPlayerId
- The player that is sending the message
- string SendingPlayerNick
- The nick name of the player that sent the message
- bool bIsFriendInvite
- Whether this is a friend invite or just a generic message
- bool bIsGameInvite
- Whether this message is a game invite or not
- bool bWasAccepted
- Whether the invite has been accepted or not
- bool bWasDenied
- Whether the invite has been denied or not
- string Message
- The corresponding message that was sent
OnlinePlayerScore[edit]
Modifiers: native
Struct holding information used when writing scoring information that is used to determine a player's skill rating
- UniqueNetId PlayerId
- The player that this score is for
- int TeamId
- The team that the player is on
- int Score
- The score for this player
RemoteTalker[edit]
Modifiers: native
Information about a remote talker
- UniqueNetId TalkerId
- The unique id for this talker
- bool bWasTalking
- Whether the remote talker was speaking last frame
SpeechRecognizedWord[edit]
Holds a word/phrase that was recognized by the speech analyzer
Note: See VoiceInterface.h to change the native layout of this struct
- int WordId
- The id of the word in the vocabulary
- string WordText
- the actual word
- float Confidence
- How confident the analyzer was in the recognition
UniqueNetId[edit]
Modifiers: native
Struct that holds a transient, unique identifier for a player
- byte Uid[8]
- The id used by the network to uniquely identify a player
Functions[edit]
Static native functions[edit]
CanAutoLogin[edit]
Returns true if auto-login credentials are set on the commandline
StringToUniqueNetId[edit]
Converts a string representing a UniqueNetId into a UniqueNetId struct.
Parameters:
- UniqueNetIdString - the string containing the text representation of the unique id.
- out_UniqueId - will receive the UniqueNetId generated from the string.
Returns:
- TRUE if the string was successfully converted into a UniqueNetId; FALSE if the string was not a valid UniqueNetId.
UniqueNetIdToString[edit]
Generates a string representation of a UniqueNetId struct.
Parameters:
- IdToConvert - the unique net id that should be converted to a string.
Returns:
- the specified UniqueNetId represented as a string.
Events[edit]
Init[edit]
Called from engine start up code to allow the subsystem to initialize
Returns:
- TRUE if the initialization was successful, FALSE otherwise
SetAccountInterface[edit]
Called from native code to assign the account interface
Parameters:
- NewInterface - the object to assign as providing the account interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetContentInterface[edit]
Called from native code to assign the content interface
Parameters:
- NewInterface - the object to assign as providing the content interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetGameInterface[edit]
Called from native code to assign the game interface
Parameters:
- NewInterface - the object to assign as providing the game interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetNewsInterface[edit]
Called from native code to assign the news interface
Parameters:
- NewInterface - the object to assign as providing the news interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetPlayerInterface[edit]
Called from native code to assign the player interface
Parameters:
- NewInterface - the object to assign as providing the player interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetPlayerInterfaceEx[edit]
Called from native code to assign the extended player interface
Parameters:
- NewInterface - the object to assign as providing the player interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetStatsInterface[edit]
Called from native code to assign the stats interface
Parameters:
- NewInterface - the object to assign as providing the stats interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetSystemInterface[edit]
Called from native code to assign the system interface
Parameters:
- NewInterface - the object to assign as providing the system interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetVoiceInterface[edit]
Called from native code to assign the voice interface
Parameters:
- NewInterface - the object to assign as providing the voice interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
