OnlineSubsystem¶

Class in Engine · Engine.OnlineSubsystem · native, abstract, config

Object › OnlineSubsystem

Using it from Lua

h7.find_all("OnlineSubsystem")            -- live instances
h7.find_class("Engine.OnlineSubsystem")   -- the class
h7.hook("Engine.OnlineSubsystem.DumpGameSettings", fn)

Enums¶

EFeaturePrivilegeLevel

FPL_Disabled = 0, FPL_EnabledFriendsOnly = 1, FPL_Enabled = 2

ELanBeaconState

LANB_NotUsingLanBeacon = 0, LANB_Hosting = 1, LANB_Searching = 2

ELoginStatus

LS_NotLoggedIn = 0, LS_UsingLocalProfile = 1, LS_LoggedIn = 2

ENATType

NAT_Unknown = 0, NAT_Open = 1, NAT_Moderate = 2, NAT_Strict = 3

ENetworkNotificationPosition

NNP_TopLeft = 0, NNP_TopCenter = 1, NNP_TopRight = 2, NNP_CenterLeft = 3, NNP_Center = 4, NNP_CenterRight = 5, NNP_BottomLeft = 6, NNP_BottomCenter = 7, NNP_BottomRight = 8

EOnlineAccountCreateStatus

OACS_CreateSuccessful = 0, OACS_UnknownError = 1, OACS_InvalidUserName = 2, OACS_InvalidPassword = 3, OACS_InvalidUniqueUserName = 4, OACS_UniqueUserNameInUse = 5, OACS_ServiceUnavailable = 6

EOnlineContentType

OCT_Downloaded = 0, OCT_SaveGame = 1

EOnlineEnumerationReadState

OERS_NotStarted = 0, OERS_InProgress = 1, OERS_Done = 2, OERS_Failed = 3

EOnlineFriendState

OFS_Offline = 0, OFS_Online = 1, OFS_Away = 2, OFS_Busy = 3

EOnlineGameState

OGS_NoSession = 0, OGS_Pending = 1, OGS_Starting = 2, OGS_InProgress = 3, OGS_Ending = 4, OGS_Ended = 5

EOnlineNewsType

ONT_Unknown = 0, ONT_GameNews = 1, ONT_ContentAnnouncements = 2, ONT_Misc = 3

EOnlineServerConnectionStatus

OSCS_NotConnected = 0, OSCS_Connected = 1, OSCS_ConnectionDropped = 2, OSCS_NoNetworkConnection = 3, OSCS_ServiceUnavailable = 4, OSCS_UpdateRequired = 5, OSCS_ServersTooBusy = 6, OSCS_DuplicateLoginDetected = 7, OSCS_InvalidUser = 8

Structs¶

AchievementDetails

Field	Type
`Id`	`int`
`AchievementName`	`string`
`Description`	`string`
`HowTo`	`string`
`Image`	`Surface`
`MonthEarned`	`byte`
`DayEarned`	`byte`
`YearEarned`	`byte`
`DayOfWeekEarned`	`byte`
`GamerPoints`	`int`
`bIsSecret`	`bool`
`bWasAchievedOnline`	`bool`
`bWasAchievedOffline`	`bool`

CommunityContentFile

Field	Type
`ContentId`	`int`
`FileId`	`int`
`ContentType`	`int`
`FileSize`	`int`
`Owner`	`UniqueNetId`
`DownloadCount`	`int`
`AverageRating`	`float`
`RatingCount`	`int`
`LastRatingGiven`	`int`
`LocalFilePath`	`string`

CommunityContentMetadata

Field	Type
`ContentType`	`int`
`MetadataItems`	`array<SettingsProperty>`

EmsFile

Field	Type
`string`	`init`
`string`	`init`
`string`	`init`
`FileSize`	`int`
`String`	`init`

FriendsQuery

Field	Type
`UniqueId`	`UniqueNetId`
`bIsFriend`	`bool`

LocalTalker

Field	Type
`bHasVoice`	`bool`
`bHasNetworkedVoice`	`bool`
`bIsRecognizingSpeech`	`bool`
`bWasTalking`	`bool`
`bIsTalking`	`bool`
`bIsRegistered`	`bool`

NamedInterface

Field	Type
`InterfaceName`	`name`
`InterfaceObject`	`Object`

NamedInterfaceDef

Field	Type
`InterfaceName`	`name`
`InterfaceClassName`	`string`

NamedSession

Field	Type
`SessionName`	`name`
`SessionInfo`	`pointer`
`GameSettings`	`OnlineGameSettings`
`Registrants`	`array<OnlineRegistrant>`
`ArbitrationRegistrants`	`array<OnlineArbitrationRegistrant>`

OnlineArbitrationRegistrant

Struct extends OnlineRegistrant

Field	Type
`MachineId`	`qword`
`Trustworthiness`	`int`

OnlineContent

Field	Type
`ContentType`	`EOnlineContentType`
`UserIndex`	`byte`
`bIsCorrupt`	`bool`
`DeviceId`	`int`
`LicenseMask`	`int`
`FriendlyName`	`string`
`Filename`	`string`
`ContentPath`	`string`
`ContentPackages`	`array`
`ContentFiles`	`array`

OnlineCrossTitleContent

Struct extends OnlineContent

Field	Type
`TitleId`	`int`

OnlineFriend

Field	Type
`UniqueId`	`UniqueNetId`
`SessionId`	`qword`
`NickName`	`string`
`PresenceInfo`	`string`
`FriendState`	`EOnlineFriendState`
`bIsOnline`	`bool`
`bIsPlaying`	`bool`
`bIsPlayingThisGame`	`bool`
`bIsJoinable`	`bool`
`bHasVoiceSupport`	`bool`
`bHaveInvited`	`bool`
`bHasInvitedYou`	`bool`

OnlineFriendMessage

Field	Type
`SendingPlayerId`	`UniqueNetId`
`SendingPlayerNick`	`string`
`bIsFriendInvite`	`bool`
`bIsGameInvite`	`bool`
`bWasAccepted`	`bool`
`bWasDenied`	`bool`
`Message`	`string`

OnlinePartyMember

Field	Type
`UniqueId`	`UniqueNetId`
`Nickname`	`string`
`LocalUserNum`	`byte`
`NatType`	`ENATType`
`TitleId`	`int`
`bIsLocal`	`bool`
`bIsInPartyVoice`	`bool`
`bIsTalking`	`bool`
`bIsInGameSession`	`bool`
`bIsPlayingThisGame`	`bool`
`SessionId`	`qword`
`Data1`	`int`
`Data2`	`int`
`Data3`	`int`
`Data4`	`int`

OnlinePlayerScore

Field	Type
`PlayerId`	`UniqueNetId`
`TeamId`	`int`
`Score`	`int`

OnlineRegistrant

Field	Type
`PlayerNetId`	`UniqueNetId`

RemoteTalker

Field	Type
`TalkerId`	`UniqueNetId`
`LastNotificationTime`	`float`
`bWasTalking`	`bool`
`bIsTalking`	`bool`
`bIsRegistered`	`bool`

SocialPostImageFlags

Field	Type
`bIsUserGeneratedImage`	`bool`
`bIsGameGeneratedImage`	`bool`
`bIsAchievementImage`	`bool`
`bIsMediaImage`	`bool`

SocialPostImageInfo

Field	Type
`Flags`	`SocialPostImageFlags`
`MessageText`	`string`
`TitleText`	`string`
`PictureCaption`	`string`
`PictureDescription`	`string`

SocialPostLinkInfo

Struct extends SocialPostImageInfo

Field	Type
`TitleURL`	`string`
`PictureURL`	`string`

SocialPostPrivileges

Field	Type
`bCanPostImage`	`bool`
`bCanPostLink`	`bool`

SpeechRecognizedWord

Field	Type
`WordId`	`int`
`WordText`	`string`
`Confidence`	`float`

TitleFile

Field	Type
`Filename`	`string`
`AsyncState`	`EOnlineEnumerationReadState`
`Data`	`array`

UniqueNetId

Field	Type
`Uid`	`QWORD`

Properties¶

Name	Type	Notes
`AccountInterface`	`OnlineAccountInterface`
`AsyncMinCompletionTime`	`float`	config
`AuthInterface`	`OnlineAuthInterface`
`BuildIdOverride`	`int`	config
`bUseBuildIdOverride`	`bool`	config
`ContentInterface`	`OnlineContentInterface`
`GameInterface`	`OnlineGameInterface`
`IniLocPatcherClassName`	`string`	config
`NamedInterfaceDefs`	`array<NamedInterfaceDef>`	config
`NamedInterfaces`	`array<NamedInterface>`	private
`NewsInterface`	`OnlineNewsInterface`
`PartyChatInterface`	`OnlinePartyChatInterface`
`Patcher`	`IniLocPatcher`	transient
`PlayerInterface`	`OnlinePlayerInterface`
`PlayerInterfaceEx`	`OnlinePlayerInterfaceEx`
`Sessions`	`array<NamedSession>`	const, protected
`SharedCloudInterface`	`SharedCloudFileInterface`
`SocialInterface`	`OnlineSocialInterface`
`StatsInterface`	`OnlineStatsInterface`
`SystemInterface`	`OnlineSystemInterface`
`TitleFileCacheInterface`	`OnlineTitleFileCacheInterface`
`TitleFileInterface`	`OnlineTitleFileInterface`
`UserCloudInterface`	`UserCloudFileInterface`
`VoiceInterface`	`OnlineVoiceInterface`

Functions¶

Name	Declaration
`DumpGameSettings`	`static function DumpGameSettings(const OnlineGameSettings GameSettings)`
`DumpSessionState`	`function DumpSessionState()`
`DumpVoiceRegistration`	`function DumpVoiceRegistration()`
`Exit`	`event Exit()`
`GetBuildUniqueId`	`native function int GetBuildUniqueId()`
`GetNamedInterface`	`event Object GetNamedInterface(name InterfaceName)`
`GetNumSupportedLogins`	`static final native function int GetNumSupportedLogins()`
`GetPlayerUniqueNetIdFromIndex`	`event UniqueNetId GetPlayerUniqueNetIdFromIndex(int UserIndex)`
`Init`	`native event bool Init()`
`PostInit`	`event bool PostInit()`
`SetAccountInterface`	`event bool SetAccountInterface(Object NewInterface)`
`SetAuthInterface`	`event bool SetAuthInterface(Object InAuthInterface)`
`SetContentInterface`	`event bool SetContentInterface(Object NewInterface)`
`SetDebugSpewLevel`	`function SetDebugSpewLevel(int DebugSpewLevel)`
`SetGameInterface`	`event bool SetGameInterface(Object NewInterface)`
`SetNamedInterface`	`event SetNamedInterface(name InterfaceName, Object NewInterface)`
`SetNewsInterface`	`event bool SetNewsInterface(Object NewInterface)`
`SetPartyChatInterface`	`event bool SetPartyChatInterface(Object NewInterface)`
`SetPlayerInterface`	`event bool SetPlayerInterface(Object NewInterface)`
`SetPlayerInterfaceEx`	`event bool SetPlayerInterfaceEx(Object NewInterface)`
`SetSharedCloudInterface`	`event bool SetSharedCloudInterface(Object InCloudInterface)`
`SetSocialInterface`	`event bool SetSocialInterface(Object InSocialInterface)`
`SetStatsInterface`	`event bool SetStatsInterface(Object NewInterface)`
`SetSystemInterface`	`event bool SetSystemInterface(Object NewInterface)`
`SetTitleFileCacheInterface`	`event bool SetTitleFileCacheInterface(Object NewInterface)`
`SetTitleFileInterface`	`event bool SetTitleFileInterface(Object NewInterface)`
`SetUserCloudInterface`	`event bool SetUserCloudInterface(Object InCloudInterface)`
`SetVoiceInterface`	`event bool SetVoiceInterface(Object NewInterface)`
`StringToUniqueNetId`	`static final native function bool StringToUniqueNetId(string UniqueNetIdString, out UniqueNetId out_UniqueId)`
`UniqueNetIdToString`	`static final native function string UniqueNetIdToString(const out UniqueNetId IdToConvert)`

Inherited¶

From	Members
Object	13 properties, 308 functions