I'm a doctor, not a mechanic
UE3:OnlineSubsystem (UDK)
 |
Object >> OnlineSubsystem |
Contents
- 1 Properties
- 1.1 AccountInterface
- 1.2 AsyncMinCompletionTime
- 1.3 BuildIdOverride
- 1.4 bUseBuildIdOverride
- 1.5 ContentInterface
- 1.6 GameInterface
- 1.7 IniLocPatcherClassName
- 1.8 NamedInterfaceDefs
- 1.9 NamedInterfaces
- 1.10 NewsInterface
- 1.11 PartyChatInterface
- 1.12 Patcher
- 1.13 PlayerInterface
- 1.14 PlayerInterfaceEx
- 1.15 Sessions
- 1.16 StatsInterface
- 1.17 SystemInterface
- 1.18 VoiceInterface
- 2 Enums
- 3 Structs
- 4 Functions
- 4.1 Static native functions
- 4.2 Other static functions
- 4.3 Native functions
- 4.4 Events
- 4.4.1 Exit
- 4.4.2 GetNamedInterface
- 4.4.3 PostInit
- 4.4.4 SetAccountInterface
- 4.4.5 SetContentInterface
- 4.4.6 SetGameInterface
- 4.4.7 SetNamedInterface
- 4.4.8 SetNewsInterface
- 4.4.9 SetPartyChatInterface
- 4.4.10 SetPlayerInterface
- 4.4.11 SetPlayerInterfaceEx
- 4.4.12 SetStatsInterface
- 4.4.13 SetSystemInterface
- 4.4.14 SetVoiceInterface
- 4.5 Other instance functions
- Package:
- Engine
- Direct subclass:
- OnlineSubsystemCommonImpl
- This class in other games:
- UT3
| 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
AccountInterface
Type: OnlineAccountInterface
The interface to use for creating and/or enumerating account information
AsyncMinCompletionTime
Type: float
Modifiers: config
Used to introduce latency when communicating with the online layer for testing purposes
BuildIdOverride
Type: int
Modifiers: config
Used to specify a build override value
bUseBuildIdOverride
Type: bool
Modifiers: config
Whether to use the override or not
ContentInterface
Type: OnlineContentInterface
The interface to use for online content
GameInterface
Type: OnlineGameInterface
The interface to use for creating, searching for, or destroying online games
IniLocPatcherClassName
Type: string
Modifiers: config
The class to create our patcher instance from
NamedInterfaceDefs
Type: array<NamedInterfaceDef>
Modifiers: config
The list of named interfaces to automatically create and store
NamedInterfaces
Type: array<NamedInterface>
Modifiers: private
Holds the set of registered named interfaces
NewsInterface
Type: OnlineNewsInterface
The interface to use for reading game specific news announcements
PartyChatInterface
Type: OnlinePartyChatInterface
The interface to use for accessing online party chat methods
Patcher
Type: IniLocPatcher
Modifiers: transient
The object responsible for patching downloaded INI/loc files
PlayerInterface
Type: OnlinePlayerInterface
The interface for accessing online player methods
PlayerInterfaceEx
Type: OnlinePlayerInterfaceEx
The interface for accessing online player extension methods
Sessions
Type: array<NamedSession>
Modifiers: const, protected
The list of sessions currently managed by the online subsystem
StatsInterface
Type: OnlineStatsInterface
The interface to use for stats read/write operations
SystemInterface
Type: OnlineSystemInterface
The interface for accessing system wide network functions
VoiceInterface
Type: OnlineVoiceInterface
The interface to use for voice communication
Enums
Structs
Functions
Static native functions
AreUniqueNetIdsEqual
Returns:
- TRUE if the netids are the same
GetNumSupportedLogins
Returns the number of players that can be signed in on this platform
StringToUniqueNetId
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
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.
Other static functions
DumpGameSettings
Logs the game settings object
Parameters:
- GameSettings - settings to dump
DumpNetIds
Log list of players' netids for debugging
Native functions
Init
Called from engine start up code to allow the subsystem to initialize
Returns:
- TRUE if the initialization was successful, FALSE otherwise
GetBuildUniqueId
Generates a unique number based off of the current script compilation
Returns:
- the unique number from the current script compilation
Events
Exit
Called from the engine shutdown code to allow the subsystem to release any resources that may have been allocated
GetNamedInterface
Returns the interface object associated with the specified name
Parameters:
- InterfaceName - the name of the interface to retrieve
Returns:
- The object that matches the interface name if found
PostInit
Used to trigger any automated tasks that need to happen just after startup
SetAccountInterface
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
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
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
SetNamedInterface
Adds the interface object to the named interface list with the specified name
Parameters:
- InterfaceName - the name of the interface to add it as
- NewInterface - the object/interface that is being cached
SetNewsInterface
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
SetPartyChatInterface
Called from native code to assign the party chat interface
Parameters:
- NewInterface - the object to assign as providing the news interface
Returns:
- TRUE if the interface is valid, FALSE otherwise
SetPlayerInterface
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
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
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
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
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
Other instance functions
DumpSessionState
Logs the session state for all sessions present
DumpVoiceRegistration
Logs the list of players that are registered for voice
SetDebugSpewLevel
Sets the debug output level for the platform specific API (if applicable)
Parameters:
- DebugSpewLevel - the level to set
