OnlinePlayerInterface¶

Interface in Engine · Engine.OnlinePlayerInterface

Using it from Lua

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

Functions¶

Name	Declaration
`AcceptFriendInvite`	`function bool AcceptFriendInvite(byte LocalUserNum, UniqueNetId RequestingPlayer)`
`AddAddFriendByNameCompleteDelegate`	`function AddAddFriendByNameCompleteDelegate(byte LocalUserNum)`
`AddFriend`	`function bool AddFriend(byte LocalUserNum, UniqueNetId NewFriend, optional string Message)`
`AddFriendByName`	`function bool AddFriendByName(byte LocalUserNum, string FriendName, optional string Message)`
`AddFriendInviteReceivedDelegate`	`function AddFriendInviteReceivedDelegate(byte LocalUserNum)`
`AddFriendMessageReceivedDelegate`	`function AddFriendMessageReceivedDelegate(byte LocalUserNum)`
`AddFriendsChangeDelegate`	`function AddFriendsChangeDelegate(byte LocalUserNum)`
`AddJoinFriendGameCompleteDelegate`	`function AddJoinFriendGameCompleteDelegate()`
`AddKeyboardInputDoneDelegate`	`function AddKeyboardInputDoneDelegate()`
`AddLoginCancelledDelegate`	`function AddLoginCancelledDelegate()`
`AddLoginChangeDelegate`	`function AddLoginChangeDelegate()`
`AddLoginFailedDelegate`	`function AddLoginFailedDelegate(byte LocalUserNum)`
`AddLoginStatusChangeDelegate`	`function AddLoginStatusChangeDelegate(byte LocalUserNum)`
`AddLogoutCompletedDelegate`	`function AddLogoutCompletedDelegate(byte LocalUserNum)`
`AddMutingChangeDelegate`	`function AddMutingChangeDelegate()`
`AddReadAchievementsCompleteDelegate`	`function AddReadAchievementsCompleteDelegate(byte LocalUserNum)`
`AddReadFriendsCompleteDelegate`	`function AddReadFriendsCompleteDelegate(byte LocalUserNum)`
`AddReadPlayerStorageCompleteDelegate`	`function AddReadPlayerStorageCompleteDelegate(byte LocalUserNum)`
`AddReadPlayerStorageForNetIdCompleteDelegate`	`function AddReadPlayerStorageForNetIdCompleteDelegate(UniqueNetId NetId)`
`AddReadProfileSettingsCompleteDelegate`	`function AddReadProfileSettingsCompleteDelegate(byte LocalUserNum)`
`AddReceivedGameInviteDelegate`	`function AddReceivedGameInviteDelegate(byte LocalUserNum)`
`AddUnlockAchievementCompleteDelegate`	`function AddUnlockAchievementCompleteDelegate(byte LocalUserNum)`
`AddWritePlayerStorageCompleteDelegate`	`function AddWritePlayerStorageCompleteDelegate(byte LocalUserNum)`
`AddWriteProfileSettingsCompleteDelegate`	`function AddWriteProfileSettingsCompleteDelegate(byte LocalUserNum)`
`AreAnyFriends`	`function bool AreAnyFriends(byte LocalUserNum, out array<FriendsQuery> Query)`
`AutoLogin`	`function bool AutoLogin()`
`CanCommunicate`	`function EFeaturePrivilegeLevel CanCommunicate(byte LocalUserNum)`
`CanDownloadUserContent`	`function EFeaturePrivilegeLevel CanDownloadUserContent(byte LocalUserNum)`
`CanPlayOnline`	`function EFeaturePrivilegeLevel CanPlayOnline(byte LocalUserNum)`
`CanPurchaseContent`	`function EFeaturePrivilegeLevel CanPurchaseContent(byte LocalUserNum)`
`CanShowPresenceInformation`	`function EFeaturePrivilegeLevel CanShowPresenceInformation(byte LocalUserNum)`
`CanViewPlayerProfiles`	`function EFeaturePrivilegeLevel CanViewPlayerProfiles(byte LocalUserNum)`
`ClearAddFriendByNameCompleteDelegate`	`function ClearAddFriendByNameCompleteDelegate(byte LocalUserNum)`
`ClearFriendInviteReceivedDelegate`	`function ClearFriendInviteReceivedDelegate(byte LocalUserNum)`
`ClearFriendMessageReceivedDelegate`	`function ClearFriendMessageReceivedDelegate(byte LocalUserNum)`
`ClearFriendsChangeDelegate`	`function ClearFriendsChangeDelegate(byte LocalUserNum)`
`ClearJoinFriendGameCompleteDelegate`	`function ClearJoinFriendGameCompleteDelegate()`
`ClearKeyboardInputDoneDelegate`	`function ClearKeyboardInputDoneDelegate()`
`ClearLoginCancelledDelegate`	`function ClearLoginCancelledDelegate()`
`ClearLoginChangeDelegate`	`function ClearLoginChangeDelegate()`
`ClearLoginFailedDelegate`	`function ClearLoginFailedDelegate(byte LocalUserNum)`
`ClearLoginStatusChangeDelegate`	`function ClearLoginStatusChangeDelegate(byte LocalUserNum)`
`ClearLogoutCompletedDelegate`	`function ClearLogoutCompletedDelegate(byte LocalUserNum)`
`ClearMutingChangeDelegate`	`function ClearMutingChangeDelegate()`
`ClearReadAchievementsCompleteDelegate`	`function ClearReadAchievementsCompleteDelegate(byte LocalUserNum)`
`ClearReadFriendsCompleteDelegate`	`function ClearReadFriendsCompleteDelegate(byte LocalUserNum)`
`ClearReadPlayerStorageCompleteDelegate`	`function ClearReadPlayerStorageCompleteDelegate(byte LocalUserNum)`
`ClearReadPlayerStorageForNetIdCompleteDelegate`	`function ClearReadPlayerStorageForNetIdCompleteDelegate(UniqueNetId NetId)`
`ClearReadProfileSettingsCompleteDelegate`	`function ClearReadProfileSettingsCompleteDelegate(byte LocalUserNum)`
`ClearReceivedGameInviteDelegate`	`function ClearReceivedGameInviteDelegate(byte LocalUserNum)`
`ClearUnlockAchievementCompleteDelegate`	`function ClearUnlockAchievementCompleteDelegate(byte LocalUserNum)`
`ClearWritePlayerStorageCompleteDelegate`	`function ClearWritePlayerStorageCompleteDelegate(byte LocalUserNum)`
`ClearWriteProfileSettingsCompleteDelegate`	`function ClearWriteProfileSettingsCompleteDelegate(byte LocalUserNum)`
`DeleteMessage`	`function bool DeleteMessage(byte LocalUserNum, int MessageIndex)`
`DenyFriendInvite`	`function bool DenyFriendInvite(byte LocalUserNum, UniqueNetId RequestingPlayer)`
`GetAchievements`	`function EOnlineEnumerationReadState GetAchievements(byte LocalUserNum, out array<AchievementDetails> Achievements, optional int TitleId = 0)`
`GetFriendMessages`	`function GetFriendMessages(byte LocalUserNum, out array<OnlineFriendMessage> FriendMessages)`
`GetFriendsList`	`function EOnlineEnumerationReadState GetFriendsList(byte LocalUserNum, out array<OnlineFriend> Friends, optional int Count, optional int StartingAt)`
`GetKeyboardInputResults`	`function string GetKeyboardInputResults(out byte bWasCanceled)`
`GetLoginStatus`	`function ELoginStatus GetLoginStatus(byte LocalUserNum)`
`GetPlayerNickname`	`function string GetPlayerNickname(byte LocalUserNum)`
`GetPlayerStorage`	`function OnlinePlayerStorage GetPlayerStorage(byte LocalUserNum)`
`GetProfileSettings`	`function OnlineProfileSettings GetProfileSettings(byte LocalUserNum)`
`GetUniquePlayerId`	`function bool GetUniquePlayerId(byte LocalUserNum, out UniqueNetId PlayerId)`
`IsFriend`	`function bool IsFriend(byte LocalUserNum, UniqueNetId PlayerId)`
`IsGuestLogin`	`function bool IsGuestLogin(byte LocalUserNum)`
`IsLocalLogin`	`function bool IsLocalLogin(byte LocalUserNum)`
`IsMuted`	`function bool IsMuted(byte LocalUserNum, UniqueNetId PlayerId)`
`JoinFriendGame`	`function bool JoinFriendGame(byte LocalUserNum, UniqueNetId Friend)`
`Login`	`function bool Login(byte LocalUserNum, string LoginName, string Password, optional bool bWantsLocalOnly)`
`Logout`	`function bool Logout(byte LocalUserNum)`
`OnAddFriendByNameComplete`	`delegate OnAddFriendByNameComplete(bool bWasSuccessful)`
`OnFriendInviteReceived`	`delegate OnFriendInviteReceived(byte LocalUserNum, UniqueNetId RequestingPlayer, string RequestingNick, string Message)`
`OnFriendMessageReceived`	`delegate OnFriendMessageReceived(byte LocalUserNum, UniqueNetId SendingPlayer, string SendingNick, string Message)`
`OnFriendsChange`	`delegate OnFriendsChange()`
`OnJoinFriendGameComplete`	`delegate OnJoinFriendGameComplete(bool bWasSuccessful)`
`OnKeyboardInputComplete`	`delegate OnKeyboardInputComplete(bool bWasSuccessful)`
`OnLoginCancelled`	`delegate OnLoginCancelled()`
`OnLoginChange`	`delegate OnLoginChange(byte LocalUserNum)`
`OnLoginFailed`	`delegate OnLoginFailed(byte LocalUserNum, EOnlineServerConnectionStatus ErrorCode)`
`OnLoginStatusChange`	`delegate OnLoginStatusChange(ELoginStatus NewStatus, UniqueNetId NewId)`
`OnLogoutCompleted`	`delegate OnLogoutCompleted(bool bWasSuccessful)`
`OnMutingChange`	`delegate OnMutingChange()`
`OnReadAchievementsComplete`	`delegate OnReadAchievementsComplete(int TitleId)`
`OnReadFriendsComplete`	`delegate OnReadFriendsComplete(bool bWasSuccessful)`
`OnReadPlayerStorageComplete`	`delegate OnReadPlayerStorageComplete(byte LocalUserNum, bool bWasSuccessful)`
`OnReadPlayerStorageForNetIdComplete`	`delegate OnReadPlayerStorageForNetIdComplete(UniqueNetId NetId, bool bWasSuccessful)`
`OnReadProfileSettingsComplete`	`delegate OnReadProfileSettingsComplete(byte LocalUserNum, bool bWasSuccessful)`
`OnReceivedGameInvite`	`delegate OnReceivedGameInvite(byte LocalUserNum, string InviterName)`
`OnUnlockAchievementComplete`	`delegate OnUnlockAchievementComplete(bool bWasSuccessful)`
`OnWritePlayerStorageComplete`	`delegate OnWritePlayerStorageComplete(byte LocalUserNum, bool bWasSuccessful)`
`OnWriteProfileSettingsComplete`	`delegate OnWriteProfileSettingsComplete(byte LocalUserNum, bool bWasSuccessful)`
`ReadAchievements`	`function bool ReadAchievements(byte LocalUserNum, optional int TitleId = 0, optional bool bShouldReadText = true, optional bool bShouldReadImages = false)`
`ReadFriendsList`	`function bool ReadFriendsList(byte LocalUserNum, optional int Count, optional int StartingAt)`
`ReadPlayerStorage`	`function bool ReadPlayerStorage(byte LocalUserNum, OnlinePlayerStorage PlayerStorage, optional int DeviceId = -1)`
`ReadPlayerStorageForNetId`	`function bool ReadPlayerStorageForNetId(byte LocalUserNum, UniqueNetId NetId, OnlinePlayerStorage PlayerStorage)`
`ReadProfileSettings`	`function bool ReadProfileSettings(byte LocalUserNum, OnlineProfileSettings ProfileSettings)`
`RemoveFriend`	`function bool RemoveFriend(byte LocalUserNum, UniqueNetId FormerFriend)`
`SendGameInviteToFriend`	`function bool SendGameInviteToFriend(byte LocalUserNum, UniqueNetId Friend, optional string Text)`
`SendGameInviteToFriends`	`function bool SendGameInviteToFriends(byte LocalUserNum, array<UniqueNetId> Friends, optional string Text)`
`SendMessageToFriend`	`function bool SendMessageToFriend(byte LocalUserNum, UniqueNetId Friend, string Message)`
`SetOnlineStatus`	`function SetOnlineStatus(byte LocalUserNum, int StatusId, const out array<LocalizedStringSetting> LocalizedStringSettings, const out array<SettingsProperty> Properties)`
`ShowFriendsUI`	`function bool ShowFriendsUI(byte LocalUserNum)`
`ShowKeyboardUI`	`function bool ShowKeyboardUI(byte LocalUserNum, string TitleText, string DescriptionText, optional bool bIsPassword = false, optional bool bShouldValidate = true, optional string DefaultText, optional int MaxResultLength = 256)`
`ShowLoginUI`	`function bool ShowLoginUI(optional bool bShowOnlineOnly = false)`
`UnlockAchievement`	`function bool UnlockAchievement(byte LocalUserNum, int AchievementId, float PercentComplete = 100.0)`
`WritePlayerStorage`	`function bool WritePlayerStorage(byte LocalUserNum, OnlinePlayerStorage PlayerStorage, optional int DeviceId = -1)`
`WriteProfileSettings`	`function bool WriteProfileSettings(byte LocalUserNum, OnlineProfileSettings ProfileSettings)`