OnlineSubsystemPC.OnlineSubsystemPC

Extends

OnlineSubsystemCommonImpl

Modifiers

native implements ( OnlinePlayerInterface , OnlineVoiceInterface , OnlineStatsInterface , OnlineSystemInterface ) config ( Engine )

Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.OnlineSubsystem
   |   
   +-- IpDrv.OnlineSubsystemCommonImpl
      |   
      +-- OnlineSubsystemPC.OnlineSubsystemPC

Delegates Summary
		OnAddFriendByNameComplete (bool bWasSuccessful)
		OnConnectionStatusChange (EOnlineServerConnectionStatus ConnectionStatus)
		OnControllerChange (int ControllerId, ool bIsConnected)
		OnExternalUIChange (bool bIsOpening)
		OnFlushOnlineStatsComplete (name SessionName, ool bWasSuccessful)
		OnFriendInviteReceived (byte LocalUserNum, niqueNetId RequestingPlayer, tring RequestingNick, tring Message)
		OnFriendMessageReceived (byte LocalUserNum, niqueNetId SendingPlayer, tring SendingNick, tring Message)
		OnFriendsChange ()
		OnJoinFriendGameComplete (bool bWasSuccessful)
		OnKeyboardInputComplete (bool bWasSuccessful)
		OnLinkStatusChange (bool bIsConnected)
		OnLoginCancelled ()
		OnLoginChange (byte LocalUserNum)
		OnLoginFailed (byte LocalUserNum, OnlineServerConnectionStatus ErrorCode)
		OnLoginStatusChange (ELoginStatus NewStatus, niqueNetId NewId)
		OnLogoutCompleted (bool bWasSuccessful)
		OnMutingChange ()
		OnPlayerTalkingStateChange (UniqueNetId Player, ool bIsTalking)
		OnReadAchievementsComplete (int TitleId)
		OnReadFriendsComplete (bool bWasSuccessful)
		OnReadOnlineStatsComplete (bool bWasSuccessful)
		OnReadPlayerStorageComplete (byte LocalUserNum, ool bWasSuccessful)
		OnReadPlayerStorageForNetIdComplete (UniqueNetId NetId, ool bWasSuccessful)
		OnReadProfileSettingsComplete (byte LocalUserNum, ool bWasSuccessful)
		OnReadTitleFileComplete (bool bWasSuccessful, tring FileName)
		OnReceivedGameInvite (byte LocalUserNum, tring InviterName)
		OnRecognitionComplete ()
		OnRegisterHostStatGuidComplete (bool bWasSuccessful)
		OnStorageDeviceChange ()
		OnUnlockAchievementComplete (bool bWasSuccessful)
		OnWritePlayerStorageComplete (byte LocalUserNum, ool bWasSuccessful)
		OnWriteProfileSettingsComplete (byte LocalUserNum, ool bWasSuccessful)

Functions Summary
	bool	AcceptFriendInvite (byte LocalUserNum, niqueNetId RequestingPlayer)
		AddAddFriendByNameCompleteDelegate (byte LocalUserNum, elegate<OnAddFriendByNameComplete> FriendDelegate)
		AddConnectionStatusChangeDelegate (delegate<OnConnectionStatusChange> ConnectionStatusDelegate)
		AddControllerChangeDelegate (delegate<OnControllerChange> ControllerChangeDelegate)
		AddExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)
		AddFlushOnlineStatsCompleteDelegate (delegate<OnFlushOnlineStatsComplete> FlushOnlineStatsCompleteDelegate)
	bool	AddFriend (byte LocalUserNum, niqueNetId NewFriend, ptional string Message)
	bool	AddFriendByName (byte LocalUserNum, tring FriendName, ptional string Message)
		AddFriendInviteReceivedDelegate (byte LocalUserNum, elegate<OnFriendInviteReceived> InviteDelegate)
		AddFriendMessageReceivedDelegate (byte LocalUserNum, elegate<OnFriendMessageReceived> MessageDelegate)
		AddFriendsChangeDelegate (byte LocalUserNum, elegate<OnFriendsChange> FriendsDelegate))
		AddJoinFriendGameCompleteDelegate (delegate<OnJoinFriendGameComplete> JoinFriendGameCompleteDelegate)
		AddKeyboardInputDoneDelegate (delegate<OnKeyboardInputComplete> InputDelegate)
		AddLinkStatusChangeDelegate (delegate<OnLinkStatusChange> LinkStatusDelegate)
		AddLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)
		AddLoginChangeDelegate (delegate<OnLoginChange> LoginDelegate)
		AddLoginFailedDelegate (byte LocalUserNum, elegate<OnLoginFailed> LoginDelegate)
		AddLoginStatusChangeDelegate (delegate<OnLoginStatusChange> LoginStatusDelegate, yte LocalUserNum)
		AddLogoutCompletedDelegate (byte LocalUserNum, elegate<OnLogoutCompleted> LogoutDelegate)
		AddMutingChangeDelegate (delegate<OnMutingChange> MutingDelegate))
		AddPlayerTalkingDelegate (delegate<OnPlayerTalkingStateChange> TalkerDelegate)
		AddReadAchievementsCompleteDelegate (byte LocalUserNum, elegate<OnReadAchievementsComplete> ReadAchievementsCompleteDelegate)
		AddReadFriendsCompleteDelegate (byte LocalUserNum, elegate<OnReadFriendsComplete> ReadFriendsCompleteDelegate))
		AddReadOnlineStatsCompleteDelegate (delegate<OnReadOnlineStatsComplete> ReadOnlineStatsCompleteDelegate)
		AddReadPlayerStorageCompleteDelegate (byte LocalUserNum, elegate<OnReadPlayerStorageComplete> ReadPlayerStorageCompleteDelegate)
		AddReadPlayerStorageForNetIdCompleteDelegate (UniqueNetId NetId, elegate<OnReadPlayerStorageForNetIdComplete> ReadPlayerStorageForNetIdCompleteDelegate)
		AddReadProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnReadProfileSettingsComplete> ReadProfileSettingsCompleteDelegate))
		AddReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)
		AddReceivedGameInviteDelegate (byte LocalUserNum, elegate<OnReceivedGameInvite> ReceivedGameInviteDelegate)
		AddRecognitionCompleteDelegate (byte LocalUserNum, elegate<OnRecognitionComplete> RecognitionDelegate))
		AddRegisterHostStatGuidCompleteDelegate (delegate<OnFlushOnlineStatsComplete> RegisterHostStatGuidCompleteDelegate)
		AddStorageDeviceChangeDelegate (delegate<OnStorageDeviceChange> StorageDeviceChangeDelegate)
		AddUnlockAchievementCompleteDelegate (byte LocalUserNum, elegate<OnUnlockAchievementComplete> UnlockAchievementCompleteDelegate)
		AddWritePlayerStorageCompleteDelegate (byte LocalUserNum, elegate<OnWritePlayerStorageComplete> WritePlayerStorageCompleteDelegate)
		AddWriteProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnWriteProfileSettingsComplete> WriteProfileSettingsCompleteDelegate))
	bool	AreAnyFriends (byte LocalUserNum, ut array<FriendsQuery> Query)
	bool	AutoLogin ()
		CalcAggregateSkill (array<double> Mus, array<double> Sigmas, out double OutAggregateMu, out double OutAggregateSigma)
	EFeaturePrivilegeLevel	CanCommunicate (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanDownloadUserContent (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanPlayOnline (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanPurchaseContent (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanShowPresenceInformation (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanViewPlayerProfiles (byte LocalUserNum)
		ClearAddFriendByNameCompleteDelegate (byte LocalUserNum, elegate<OnAddFriendByNameComplete> FriendDelegate)
		ClearConnectionStatusChangeDelegate (delegate<OnConnectionStatusChange> ConnectionStatusDelegate)
		ClearControllerChangeDelegate (delegate<OnControllerChange> ControllerChangeDelegate)
		ClearExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)
		ClearFlushOnlineStatsCompleteDelegate (delegate<OnFlushOnlineStatsComplete> FlushOnlineStatsCompleteDelegate)
		ClearFriendInviteReceivedDelegate (byte LocalUserNum, elegate<OnFriendInviteReceived> InviteDelegate)
		ClearFriendMessageReceivedDelegate (byte LocalUserNum, elegate<OnFriendMessageReceived> MessageDelegate)
		ClearFriendsChangeDelegate (byte LocalUserNum, elegate<OnFriendsChange> FriendsDelegate))
		ClearJoinFriendGameCompleteDelegate (delegate<OnJoinFriendGameComplete> JoinFriendGameCompleteDelegate)
		ClearKeyboardInputDoneDelegate (delegate<OnKeyboardInputComplete> InputDelegate)
		ClearLinkStatusChangeDelegate (delegate<OnLinkStatusChange> LinkStatusDelegate)
		ClearLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)
		ClearLoginChangeDelegate (delegate<OnLoginChange> LoginDelegate)
		ClearLoginFailedDelegate (byte LocalUserNum, elegate<OnLoginFailed> LoginDelegate)
		ClearLoginStatusChangeDelegate (delegate<OnLoginStatusChange> LoginStatusDelegate, yte LocalUserNum)
		ClearLogoutCompletedDelegate (byte LocalUserNum, elegate<OnLogoutCompleted> LogoutDelegate)
		ClearMutingChangeDelegate (delegate<OnFriendsChange> MutingDelegate))
		ClearPlayerTalkingDelegate (delegate<OnPlayerTalkingStateChange> TalkerDelegate)
		ClearReadAchievementsCompleteDelegate (byte LocalUserNum, elegate<OnReadAchievementsComplete> ReadAchievementsCompleteDelegate)
		ClearReadFriendsCompleteDelegate (byte LocalUserNum, elegate<OnReadFriendsComplete> ReadFriendsCompleteDelegate))
		ClearReadOnlineStatsCompleteDelegate (delegate<OnReadOnlineStatsComplete> ReadOnlineStatsCompleteDelegate)
		ClearReadPlayerStorageCompleteDelegate (byte LocalUserNum, elegate<OnReadPlayerStorageComplete> ReadPlayerStorageCompleteDelegate)
		ClearReadPlayerStorageForNetIdCompleteDelegate (UniqueNetId NetId, elegate<OnReadPlayerStorageForNetIdComplete> ReadPlayerStorageForNetIdCompleteDelegate)
		ClearReadProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnReadProfileSettingsComplete> ReadProfileSettingsCompleteDelegate))
		ClearReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)
		ClearReceivedGameInviteDelegate (byte LocalUserNum, elegate<OnReceivedGameInvite> ReceivedGameInviteDelegate)
		ClearRecognitionCompleteDelegate (byte LocalUserNum, elegate<OnRecognitionComplete> RecognitionDelegate))
		ClearRegisterHostStatGuidCompleteDelegateDelegate (delegate<OnFlushOnlineStatsComplete> RegisterHostStatGuidCompleteDelegate)
		ClearStorageDeviceChangeDelegate (delegate<OnStorageDeviceChange> StorageDeviceChangeDelegate)
		ClearUnlockAchievementCompleteDelegate (byte LocalUserNum, elegate<OnUnlockAchievementComplete> UnlockAchievementCompleteDelegate)
		ClearWritePlayerStorageCompleteDelegate (byte LocalUserNum, elegate<OnWritePlayerStorageComplete> WritePlayerStorageCompleteDelegate)
		ClearWriteProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnWriteProfileSettingsComplete> WriteProfileSettingsCompleteDelegate))
	bool	DeleteMessage (byte LocalUserNum, nt MessageIndex)
	bool	DenyFriendInvite (byte LocalUserNum, niqueNetId RequestingPlayer)
	bool	FlushOnlineStats (name SessionName)
		FreeStats (OnlineStatsRead StatsRead)
	EOnlineEnumerationReadState	GetAchievements (byte LocalUserNum, ut array<AchievementDetails> Achievements, ptional int TitleId = 0)
	string	GetClientStatGuid ()
		GetFriendMessages (byte LocalUserNum, ut array<OnlineFriendMessage> FriendMessages)
	EOnlineEnumerationReadState	GetFriendsList (byte LocalUserNum, ut array<OnlineFriend> Friends, ptional int Count, ptional int StartingAt)
	string	GetHostStatGuid ()
	string	GetKeyboardInputResults (out byte bWasCanceled)
	int	GetLocale ()))
	ELoginStatus	GetLoginStatus (byte LocalUserNum))
	ENATType	GetNATType ()))
	ENetworkNotificationPosition	GetNetworkNotificationPosition ()
	string	GetPlayerNickname (byte LocalUserNum))
	string	GetPlayerNicknameFromIndex (int UserIndex))
	OnlinePlayerStorage	GetPlayerStorage (byte LocalUserNum))
	UniqueNetId	GetPlayerUniqueNetIdFromIndex (int UserIndex))
	OnlineProfileSettings	GetProfileSettings (byte LocalUserNum))
	bool	GetRecognitionResults (byte LocalUserNum, ut array<SpeechRecognizedWord> Words)
	bool	GetTitleFileContents (string FileName, ut array<byte> FileContents)
	EOnlineEnumerationReadState	GetTitleFileState (string FileName)
	bool	GetUniquePlayerId (byte LocalUserNum, ut UniqueNetId PlayerId))
	bool	HasLinkConnection ()))
	bool	Init ()
	bool	IsControllerConnected (int ControllerId))
	bool	IsFriend (byte LocalUserNum, niqueNetId PlayerId)
	bool	IsGuestLogin (byte LocalUserNum)
	bool	IsHeadsetPresent (byte LocalUserNum)
	bool	IsLocalLogin (byte LocalUserNum)
	bool	IsLocalPlayerTalking (byte LocalUserNum)
	bool	IsMuted (byte LocalUserNum, niqueNetId PlayerId)
	bool	IsRemotePlayerTalking (UniqueNetId PlayerId)
	bool	JoinFriendGame (byte LocalUserNum, niqueNetId Friend)
	bool	Login (byte LocalUserNum, tring LoginName, tring Password, ptional bool bWantsLocalOnly)
	bool	Logout (byte LocalUserNum)
	bool	MuteAll (byte LocalUserNum, ool bAllowFriends)
	bool	MuteRemoteTalker (byte LocalUserNum, niqueNetId PlayerId, ptional bool bIsSystemWide)
	bool	ReadAchievements (byte LocalUserNum, ptional int TitleId = 0, ptional bool bShouldReadText = true, ptional bool bShouldReadImages = false)
	bool	ReadFriendsList (byte LocalUserNum, ptional int Count, ptional int StartingAt)
	bool	ReadOnlineStats (const out array<UniqueNetId> Players, nlineStatsRead StatsRead)
	bool	ReadOnlineStatsByRank (OnlineStatsRead StatsRead, ptional int StartIndex = 1, ptional int NumToRead = 100)
	bool	ReadOnlineStatsByRankAroundPlayer (byte LocalUserNum, nlineStatsRead StatsRead, ptional int NumRows = 10)
	bool	ReadOnlineStatsForFriends (byte LocalUserNum, nlineStatsRead StatsRead)
	bool	ReadPlayerStorage (byte LocalUserNum, nlinePlayerStorage PlayerStorage, ptional int DeviceId = -1)
	bool	ReadPlayerStorageForNetId (byte LocalUserNum, niqueNetId NetId, nlinePlayerStorage PlayerStorage)
	bool	ReadProfileSettings (byte LocalUserNum, nlineProfileSettings ProfileSettings)
	bool	ReadTitleFile (string FileToRead)
	bool	RegisterHostStatGuid (const out string HostStatGuid)
	bool	RegisterLocalTalker (byte LocalUserNum)
	bool	RegisterRemoteTalker (UniqueNetId PlayerId)
	bool	RegisterStatGuid (UniqueNetId PlayerId, onst out string ClientStatGuid)
	bool	RemoveFriend (byte LocalUserNum, niqueNetId FormerFriend)
	bool	SelectVocabulary (byte LocalUserNum, nt VocabularyId)
	bool	SendGameInviteToFriend (byte LocalUserNum, niqueNetId Friend, ptional string Text)
	bool	SendGameInviteToFriends (byte LocalUserNum, rray<UniqueNetId> Friends, ptional string Text)
	bool	SendMessageToFriend (byte LocalUserNum, niqueNetId Friend, tring Message)
		SetNetworkNotificationPosition (ENetworkNotificationPosition NewPos)
		SetOnlineStatus (byte LocalUserNum, nt StatusId, onst out array<LocalizedStringSetting> LocalizedStringSettings, onst out array<SettingsProperty> Properties)
	bool	SetRemoteTalkerPriority (byte LocalUserNum, niqueNetId PlayerId, nt Priority)
	bool	SetSpeechRecognitionObject (byte LocalUserNum, peechRecognition SpeechRecogObj)
	bool	ShowFriendsUI (byte LocalUserNum)
	bool	ShowKeyboardUI (byte LocalUserNum, tring TitleText, tring DescriptionText, optional bool bIsPassword = false, optional bool bShouldValidate = true, optional string DefaultText, optional int MaxResultLength = 256)
	bool	ShowLoginUI (optional bool bShowOnlineOnly = false)
		StartNetworkedVoice (byte LocalUserNum)
	bool	StartSpeechRecognition (byte LocalUserNum)
		StopNetworkedVoice (byte LocalUserNum)
	bool	StopSpeechRecognition (byte LocalUserNum)
	bool	UnlockAchievement (byte LocalUserNum, nt AchievementId)
	bool	UnmuteAll (byte LocalUserNum)
	bool	UnmuteRemoteTalker (byte LocalUserNum, niqueNetId PlayerId, ptional bool bIsSystemWide)
	bool	UnregisterLocalTalker (byte LocalUserNum)
	bool	UnregisterRemoteTalker (UniqueNetId PlayerId)
	bool	WriteOnlinePlayerScores (name SessionName, nt LeaderboardId, onst out array<OnlinePlayerScore> PlayerScores)
	bool	WriteOnlineStats (name SessionName, niqueNetId Player, nlineStatsWrite StatsWrite)
	bool	WritePlayerStorage (byte LocalUserNum, nlinePlayerStorage PlayerStorage, ptional int DeviceId = -1)
	bool	WriteProfileSettings (byte LocalUserNum, nlineProfileSettings ProfileSettings)

AsyncTasks Source code

This is the array of pending async tasks. Each tick these tasks are checked for completion. If complete, the delegate associated with them is called

CachedProfile Source code

The cached profile for the player

FriendsChangeDelegates Source code

The array of delegates that notify that the friends list has changed

LoggedInPlayerId Source code

The unique id of the logged in player

LoggedInPlayerName Source code

The name of the player that is logged in

MutingChangeDelegates Source code

The array of delegates that notify that the mute list has changed

ProfileDataDirectory Source code

The directory profile data should be stored in

ProfileDataExtension Source code

The file extension to use when saving profile data

ReadFriendsDelegates Source code

The array of delegates that notify read completion of the friends list data

ReadProfileSettingsDelegates Source code

The array of delegates that notify read completion of profile data

SpeechRecognitionCompleteDelegates Source code

List of callbacks to notify when speech recognition is complete

WriteProfileSettingsDelegates Source code

The array of delegates that notify write completion of profile data

OnAddFriendByNameComplete Source code

Called when a friend invite arrives for a local player
@param bWasSuccessful true if successfully added, false if not found or failed

OnConnectionStatusChange Source code

Delegate fire when the online server connection state changes
@param ConnectionStatus the new connection status

OnControllerChange Source code

Delegate fired when the controller becomes dis/connected
@param ControllerId the id of the controller that changed connection state
@param bIsConnected whether the controller connected (true) or disconnected (false)

OnExternalUIChange Source code

Delegate fired when an external UI display state changes (opening/closing)
@param bIsOpening whether the external UI is opening or closing

OnFlushOnlineStatsComplete Source code

Delegate called when the stats flush operation has completed
@param SessionName the name of the session having stats flushed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnFriendInviteReceived Source code

Called when a friend invite arrives for a local player
@param LocalUserNum the user that is receiving the invite
@param RequestingPlayer the player sending the friend request
@param RequestingNick the nick of the player sending the friend request
@param Message the message to display to the recipient

OnFriendMessageReceived Source code

Called when a friend invite arrives for a local player
@param LocalUserNum the user that is receiving the message
@param SendingPlayer the player sending the message
@param SendingNick the nick of the player sending the message
@param Message the message to display to the recipient

OnFriendsChange Source code

Delegate used in friends list change notifications

OnJoinFriendGameComplete Source code

Called once the join task has completed
@param bWasSuccessful the session was found and is joinable, false otherwise

OnKeyboardInputComplete Source code

Delegate used when the keyboard input request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnLinkStatusChange Source code

Delegate fired when the network link status changes
@param bIsConnected whether the link is currently connected or not

OnLoginCancelled Source code

Delegate used to notify when a login request was cancelled by the user

OnLoginChange Source code

Delegate used in login notifications
@param LocalUserNum the player that had the login change

OnLoginFailed Source code

Delegate used in notifying the UI/game that the manual login failed
@param LocalUserNum the controller number of the associated user
@param ErrorCode the async error code that occurred

OnLoginStatusChange Source code

Delegate called when a player's status changes but doesn't change profiles
@param NewStatus the new login status for the user
@param NewId the new id to associate with the user

OnLogoutCompleted Source code

Delegate used in notifying the UI/game that the manual logout completed
@param bWasSuccessful whether the async call completed properly or not

OnMutingChange Source code

Delegate used in mute list change notifications

OnPlayerTalkingStateChange Source code

Called when a player is talking either locally or remote. This will be called once for each active talker each frame.
@param Player the player that is talking
@param bIsTalking if true, the player is now talking, if false they are no longer talking

OnReadAchievementsComplete Source code

Called when the async achievements read has completed
@param TitleId the title id that the read was for (0 means current title)

OnReadFriendsComplete Source code

Delegate used when the friends read request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnReadOnlineStatsComplete Source code

Notifies the interested party that the last stats read has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnReadPlayerStorageComplete Source code

Delegate used when the last read of online player storage data request has completed
@param LocalUserNum the controller index of the player who's read just completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnReadPlayerStorageForNetIdComplete Source code

Delegate used when the last read of online player storage data request has completed
@param NetId the net id for the user who's read just completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnReadProfileSettingsComplete Source code

Delegate used when the last read profile settings request has completed
@param LocalUserNum the controller index of the player who's read just completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnReadTitleFileComplete Source code

Delegate fired when a file read from the network platform's title specific storage is complete
@param bWasSuccessful whether the file read was successful or not
@param FileName the name of the file this was for

OnReceivedGameInvite Source code

Called when the online system receives a game invite that needs handling
@param LocalUserNum the user that is receiving the invite
@param InviterName the nick name of the person sending the invite

OnRecognitionComplete Source code

Called when speech recognition for a given player has completed. The consumer of the notification can call GetRecognitionResults() to get the words that were recognized

OnRegisterHostStatGuidComplete Source code

Called when the host stat guid registration is complete
@param bWasSuccessful whether the registration has completed or not

OnStorageDeviceChange Source code

Delegate fired when a storage device change is detected

OnUnlockAchievementComplete Source code

Delegate used when the achievement unlocking has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnWritePlayerStorageComplete Source code

Delegate used when the last write online player storage request has completed
@param LocalUserNum the controller index of the player who's write just completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnWriteProfileSettingsComplete Source code

Delegate used when the last write profile settings request has completed
@param LocalUserNum the controller index of the player who's write just completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

AcceptFriendInvite Source code

Used to accept a friend invite sent to this player
@param LocalUserNum the user the invite is for
@param RequestingPlayer the player the invite is from
@param true if successful, false otherwise

AddAddFriendByNameCompleteDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a friend invite
@param LocalUserNum the user associated with the notification
@param FriendDelegate the delegate to use for notifications

AddConnectionStatusChangeDelegate Source code

Adds the delegate to the list to be notified when the connection status changes
@param ConnectionStatusDelegate the delegate to add

AddControllerChangeDelegate Source code

Sets the delegate used to notify the gameplay code that the controller state changed
@param ControllerChangeDelegate the delegate to use for notifications

AddExternalUIChangeDelegate Source code

Sets the delegate used to notify the gameplay code that external UI state changed (opened/closed)
@param ExternalUIDelegate the delegate to use for notifications

AddFlushOnlineStatsCompleteDelegate Source code

Adds the delegate used to notify the gameplay code that the stats flush has completed
@param FlushOnlineStatsCompleteDelegate the delegate to use for notifications

AddFriend Source code

Sends a friend invite to the specified player
@param LocalUserNum the user that is sending the invite
@param NewFriend the player to send the friend request to
@param Message the message to display to the recipient
@return true if successful, false otherwise

AddFriendByName Source code

Sends a friend invite to the specified player nick
@param LocalUserNum the user that is sending the invite
@param FriendName the name of the player to send the invite to
@param Message the message to display to the recipient
@return true if successful, false otherwise

AddFriendInviteReceivedDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a friend invite
@param LocalUserNum the user associated with the notification
@param InviteDelegate the delegate to use for notifications

AddFriendMessageReceivedDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a friend invite
@param LocalUserNum the user associated with the notification
@param MessageDelegate the delegate to use for notifications

AddFriendsChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a friends list changed
@param LocalUserNum the user to read the friends list of
@param FriendsDelegate the delegate to use for notifications

AddJoinFriendGameCompleteDelegate Source code

Sets the delegate used to notify when the join friend is complete
@param JoinFriendGameCompleteDelegate the delegate to use for notifications

AddKeyboardInputDoneDelegate Source code

Adds the delegate used to notify the gameplay code that the user has completed their keyboard input
@param InputDelegate the delegate to use for notifications

AddLinkStatusChangeDelegate Source code

Adds the delegate used to notify the gameplay code that link status changed
@param LinkStatusDelegate the delegate to use for notifications

AddLoginCancelledDelegate Source code

Adds a delegate to the list of delegates that are fired when a login is cancelled
@param CancelledDelegate the delegate to add to the list

AddLoginChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a login changed
@param LoginDelegate the delegate to use for notifications
@param LocalUserNum whether to watch for changes on a specific slot or all slots

AddLoginFailedDelegate Source code

Sets the delegate used to notify the gameplay code that a login failed
@param LocalUserNum the controller number of the associated user
@param LoginDelegate the delegate to use for notifications

AddLoginStatusChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a login status has changed
@param LoginDelegate the delegate to use for notifications
@param LocalUserNum the player to watch login status changes for

AddLogoutCompletedDelegate Source code

Sets the delegate used to notify the gameplay code that a logout completed
@param LocalUserNum the controller number of the associated user
@param LogoutDelegate the delegate to use for notifications

AddMutingChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a muting list changed
@param MutingDelegate the delegate to use for notifications

AddPlayerTalkingDelegate Source code

Adds a talker delegate to the list of notifications
@param TalkerDelegate the delegate to call when a player is talking

AddReadAchievementsCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the achievements read request has completed
@param LocalUserNum the user to read the achievements list for
@param ReadAchievementsCompleteDelegate the delegate to use for notifications

AddReadFriendsCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the friends read request has completed
@param LocalUserNum the user to read the friends list of
@param ReadFriendsCompleteDelegate the delegate to use for notifications

AddReadOnlineStatsCompleteDelegate Source code

Adds the delegate to a list used to notify the gameplay code that the stats read has completed
@param ReadOnlineStatsCompleteDelegate the delegate to use for notifications

AddReadPlayerStorageCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last read request has completed
@param LocalUserNum which user to watch for read complete notifications
@param ReadPlayerStorageCompleteDelegate the delegate to use for notifications

AddReadPlayerStorageForNetIdCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last read request has completed
@param NetId the net id for the user to watch for read complete notifications
@param ReadPlayerStorageForNetIdCompleteDelegate the delegate to use for notifications

AddReadProfileSettingsCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last read request has completed
@param LocalUserNum which user to watch for read complete notifications
@param ReadProfileSettingsCompleteDelegate the delegate to use for notifications

AddReadTitleFileCompleteDelegate Source code

Adds the delegate to the list to be notified when a requested file has been read
@param ReadTitleFileCompleteDelegate the delegate to add

AddReceivedGameInviteDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a game invite
@param LocalUserNum the user associated with the notification
@param ReceivedGameInviteDelegate the delegate to use for notifications

AddRecognitionCompleteDelegate Source code

Sets the speech recognition notification callback to use for the specified user
@param LocalUserNum the local user to receive notifications for
@param RecognitionDelegate the delegate to call when recognition is complete

AddRegisterHostStatGuidCompleteDelegate Source code

Adds the delegate for notifying when the host guid registration is done
@param RegisterHostStatGuidCompleteDelegate the delegate to use for notifications

AddStorageDeviceChangeDelegate Source code

Adds the delegate to the list to be notified when a storage device changes
@param StorageDeviceChangeDelegate the delegate to add

AddUnlockAchievementCompleteDelegate Source code

Adds the delegate used to notify the gameplay code that the achievement unlocking has completed
@param LocalUserNum which user to watch for read complete notifications
@param UnlockAchievementCompleteDelegate the delegate to use for notifications

AddWritePlayerStorageCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last write request has completed
@param LocalUserNum which user to watch for write complete notifications
@param WritePlayerStorageCompleteDelegate the delegate to use for notifications

AddWriteProfileSettingsCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last read request has completed
@param LocalUserNum which user to watch for read complete notifications
@param ReadProfileSettingsCompleteDelegate the delegate to use for notifications

AreAnyFriends Source code

Checks that whether a group of player ids are among the specified player's friends
@param LocalUserNum the controller number of the associated user
@param Query an array of players to check for being included on the friends list
@return TRUE if the call succeeded, FALSE otherwise

AutoLogin Source code

Logs the player into the online service using parameters passed on the command line. Expects -Login= -Password=. If either are missing, the function returns false and doesn't start the login process
@return true if the async call started ok, false otherwise

CalcAggregateSkill Source code

Calculates the aggregate skill from an array of skills.
@param Mus - array that holds the mu values
@param Sigmas - array that holds the sigma values
@param OutAggregateMu - aggregate Mu
@param OutAggregateSigma - aggregate Sigma

CanCommunicate Source code

Determines whether the player is allowed to use voice or text chat online
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanDownloadUserContent Source code

Determines whether the player is allowed to download user created content
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanPlayOnline Source code

Determines whether the player is allowed to play online
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanPurchaseContent Source code

Determines whether the player is allowed to buy content online
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanShowPresenceInformation Source code

Determines whether the player is allowed to have their online presence information shown to remote clients
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanViewPlayerProfiles Source code

Determines whether the player is allowed to view other people's player profile
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

ClearAddFriendByNameCompleteDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param FriendDelegate the delegate to use for notifications

ClearConnectionStatusChangeDelegate Source code

Removes the delegate from the notify list
@param ConnectionStatusDelegate the delegate to remove

ClearControllerChangeDelegate Source code

Removes the delegate used to notify the gameplay code that the controller state changed
@param ControllerChangeDelegate the delegate to remove

ClearExternalUIChangeDelegate Source code

Removes the delegate from the notification list
@param ExternalUIDelegate the delegate to remove

ClearFlushOnlineStatsCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the stats flush has completed
@param FlushOnlineStatsCompleteDelegate the delegate to use for notifications

ClearFriendInviteReceivedDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param InviteDelegate the delegate to use for notifications

ClearFriendMessageReceivedDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param MessageDelegate the delegate to use for notifications

ClearFriendsChangeDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param LocalUserNum the user to read the friends list of
@param FriendsDelegate the delegate to use for notifications

ClearJoinFriendGameCompleteDelegate Source code

Removes the delegate from the list of notifications
@param JoinFriendGameCompleteDelegate the delegate to use for notifications

ClearKeyboardInputDoneDelegate Source code

Clears the delegate used to notify the gameplay code that the user has completed their keyboard input
@param InputDelegate the delegate to use for notifications

ClearLinkStatusChangeDelegate Source code

Removes the delegate from the notify list
@param LinkStatusDelegate the delegate to remove

ClearLoginCancelledDelegate Source code

Removes the specified delegate from the notification list
@param CancelledDelegate the delegate to remove fromt he list

ClearLoginChangeDelegate Source code

Removes the specified delegate from the notification list
@param LoginDelegate the delegate to use for notifications
@param LocalUserNum whether to watch for changes on a specific slot or all slots

ClearLoginFailedDelegate Source code

Removes the specified delegate from the notification list
@param LocalUserNum the controller number of the associated user
@param LoginDelegate the delegate to use for notifications

ClearLoginStatusChangeDelegate Source code

Removes the specified delegate from the notification list
@param LoginDelegate the delegate to use for notifications
@param LocalUserNum the player to watch login status changes for

ClearLogoutCompletedDelegate Source code

Removes the specified delegate from the notification list
@param LocalUserNum the controller number of the associated user
@param LogoutDelegate the delegate to use for notifications

ClearMutingChangeDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param FriendsDelegate the delegate to use for notifications

ClearPlayerTalkingDelegate Source code

Removes a talker delegate to the list of notifications
@param TalkerDelegate the delegate to remove from the notification list

ClearReadAchievementsCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the achievements read request has completed
@param LocalUserNum the user to read the achievements list for
@param ReadAchievementsCompleteDelegate the delegate to use for notifications

ClearReadFriendsCompleteDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param LocalUserNum which user to watch for read complete notifications
@param ReadFriendsCompleteDelegate the delegate to find and clear

ClearReadOnlineStatsCompleteDelegate Source code

Removes the delegate from the notify list
@param ReadOnlineStatsCompleteDelegate the delegate to use for notifications

ClearReadPlayerStorageCompleteDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param LocalUserNum which user to watch for read complete notifications
@param ReadPlayerStorageCompleteDelegate the delegate to find and clear

ClearReadPlayerStorageForNetIdCompleteDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param NetId the net id for the user to watch for read complete notifications
@param ReadPlayerStorageForNetIdCompleteDelegate the delegate to find and clear

ClearReadProfileSettingsCompleteDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param LocalUserNum which user to watch for read complete notifications
@param ReadProfileSettingsCompleteDelegate the delegate to find and clear

ClearReadTitleFileCompleteDelegate Source code

Removes the delegate from the notify list
@param ReadTitleFileCompleteDelegate the delegate to remove

ClearReceivedGameInviteDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param ReceivedGameInviteDelegate the delegate to use for notifications

ClearRecognitionCompleteDelegate Source code

Clears the speech recognition notification callback to use for the specified user
@param LocalUserNum the local user to receive notifications for
@param RecognitionDelegate the delegate to call when recognition is complete

ClearRegisterHostStatGuidCompleteDelegateDelegate Source code

Clears the delegate used to notify the gameplay code
@param RegisterHostStatGuidCompleteDelegate the delegate to use for notifications

ClearStorageDeviceChangeDelegate Source code

Removes the delegate from the notify list
@param ConnectionStatusDelegate the delegate to remove

ClearUnlockAchievementCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the achievement unlocking has completed
@param LocalUserNum which user to watch for read complete notifications
@param UnlockAchievementCompleteDelegate the delegate to use for notifications

ClearWritePlayerStorageCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the last write request has completed
@param LocalUserNum which user to watch for write complete notifications
@param WritePlayerStorageCompleteDelegate the delegate to use for notifications

ClearWriteProfileSettingsCompleteDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param LocalUserNum which user to watch for read complete notifications
@param ReadProfileSettingsCompleteDelegate the delegate to find and clear

DeleteMessage Source code

Deletes a message from the list of messages
@param LocalUserNum the user that is deleting the message
@param MessageIndex the index of the message to delete
@return true if the message was deleted, false otherwise

DenyFriendInvite Source code

Used to deny a friend request sent to this player
@param LocalUserNum the user the invite is for
@param RequestingPlayer the player the invite is from
@param true if successful, false otherwise

FlushOnlineStats Source code

Commits any changes in the online stats cache to the permanent storage
@param SessionName the name of the session having stats flushed
@return TRUE if the call is successful, FALSE otherwise

FreeStats Source code

Cleans up any platform specific allocated data contained in the stats data
@param StatsRead the object to handle per platform clean up on

GetAchievements Source code

Copies the list of achievements for the specified player and title id
@param LocalUserNum the user to read the friends list of
@param Achievements the out array that receives the copied data
@param TitleId the title id of the game that these were read for
@return OERS_Done if the read has completed, otherwise one of the other states

GetClientStatGuid Source code

Reads the client's stat guid that was generated by registering the host's guid Used for synching up stats. Only valid on the client. Only callable after the host registration has completed
@return the client's stat guid

GetFriendMessages Source code

Returns the list of messages for the specified player
@param LocalUserNum the local player wanting to join
@param FriendMessages the set of messages cached locally for the player

GetFriendsList Source code

Copies the list of friends for the player previously retrieved from the online service. The list can be retrieved in whole or in part.
@param LocalUserNum the user to read the friends list of
@param Friends the out array that receives the copied data
@param Count the number of friends to read or zero for all
@param StartingAt the index of the friends list to start at (for pulling partial lists)
@return OERS_Done if the read has completed, otherwise one of the other states

GetHostStatGuid Source code

Reads the host's stat guid for synching up stats. Only valid on the host.
@return the host's stat guid

GetKeyboardInputResults Source code

Fetches the results of the input
@param bWasCancelled whether the user canceled the input or not
@return the string entered by the user. Note the string will be empty if it fails validation

GetLocale Source code

Determine the locale (country code) for the player

GetLoginStatus Source code

Fetches the login status for a given player
@param LocalUserNum the controller number of the associated user
@return the enum value of their status

GetNATType Source code

Determines the NAT type the player is using

GetNetworkNotificationPosition Source code

Determines the current notification position setting

GetPlayerNickname Source code

Reads the player's nick name from the online service
@param LocalUserNum the controller number of the associated user
@return a string containing the players nick name

GetPlayerNicknameFromIndex Source code

Returns the name of the player for the specified index
@param UserIndex the user to return the name of
@return the name of the player at the specified index

GetPlayerStorage Source code

Returns the online player storage for a given local user
@param LocalUserNum the user that we are reading the data for
@return the player storage object

GetPlayerUniqueNetIdFromIndex Source code

Returns the unique id of the player for the specified index
@param UserIndex the user to return the id of
@return the unique id of the player at the specified index

GetProfileSettings Source code

Returns the online profile settings for a given user
@param LocalUserNum the user that we are reading the data for
@return the profile settings object

GetRecognitionResults Source code

Gets the results of the voice recognition
@param LocalUserNum the local user to read the results of
@param Words the set of words that were recognized by the voice analyzer
@return true upon success, false otherwise

GetTitleFileContents Source code

Copies the file data into the specified buffer for the specified file
@param FileName the name of the file to read
@param FileContents the out buffer to copy the data into
@return true if the data was copied, false otherwise

GetTitleFileState Source code

Determines the async state of the tile file read operation
@param FileName the name of the file to check on
@return the async state of the file read

GetUniquePlayerId Source code

Gets the platform specific unique id for the specified player
@param LocalUserNum the controller number of the associated user
@param PlayerId the byte array that will receive the id
@return TRUE if the call succeeded, FALSE otherwise

HasLinkConnection Source code

Determines if the ethernet link is connected or not

Init Source code

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

IsControllerConnected Source code

Determines if the specified controller is connected or not
@param ControllerId the controller to query
@return true if connected, false otherwise

IsFriend Source code

Checks that a unique player id is part of the specified user's friends list
@param LocalUserNum the controller number of the associated user
@param PlayerId the id of the player being checked
@return TRUE if a member of their friends list, FALSE otherwise

IsGuestLogin Source code

Determines whether the specified user is a guest login or not
@param LocalUserNum the controller number of the associated user
@return true if a guest, false otherwise

IsHeadsetPresent Source code

Determines if the specified player has a headset connected
@param LocalUserNum the local player index being queried
@return TRUE if the player has a headset plugged in, FALSE otherwise

IsLocalLogin Source code

Determines whether the specified user is a local (non-online) login or not
@param LocalUserNum the controller number of the associated user
@return true if a local profile, false otherwise

IsLocalPlayerTalking Source code

Determines if the specified player is actively talking into the mic
@param LocalUserNum the local player index being queried
@return TRUE if the player is talking, FALSE otherwise

IsMuted Source code

Checks that a unique player id is on the specified user's mute list
@param LocalUserNum the controller number of the associated user
@param PlayerId the id of the player being checked
@return TRUE if the player should be muted, FALSE otherwise

IsRemotePlayerTalking Source code

Determines if the specified remote player is actively talking into the mic NOTE: Network latencies will make this not 100% accurate
@param PlayerId the unique id of the remote player being queried
@return TRUE if the player is talking, FALSE otherwise

JoinFriendGame Source code

Allows the local player to follow a friend into a game
@param LocalUserNum the local player wanting to join
@param Friend the player that is being followed
@return true if the async call worked, false otherwise

Login Source code

Logs the player into the online service. If this fails, it generates a OnLoginFailed notification
@param LocalUserNum the controller number of the associated user
@param LoginName the unique identifier for the player
@param Password the password for this account
@param bWantsLocalOnly whether the player wants to sign in locally only or not
@return true if the async call started ok, false otherwise

Logout Source code

Signs the player out of the online service
@param LocalUserNum the controller number of the associated user
@return TRUE if the call succeeded, FALSE otherwise

MuteAll Source code

Mutes all voice or all but friends
@param LocalUserNum the local user that is making the change
@param bAllowFriends whether to mute everyone or allow friends

MuteRemoteTalker Source code

Mutes a remote talker for the specified local player. NOTE: This only mutes them in the game unless the bIsSystemWide flag is true, which attempts to mute them globally
@param LocalUserNum the user that is muting the remote talker
@param PlayerId the remote talker that is being muted
@param bIsSystemWide whether to try to mute them globally or not
@return TRUE if the function succeeds, FALSE otherwise

ReadAchievements Source code

Starts an async read for the achievement list
@param LocalUserNum the controller number of the associated user
@param TitleId the title id of the game the achievements are to be read for
@param bShouldReadText whether to fetch the text strings or not
@param bShouldReadImages whether to fetch the image data or not
@return TRUE if the task starts, FALSE if it failed

ReadFriendsList Source code

Starts an async task that retrieves the list of friends for the player from the online service. The list can be retrieved in whole or in part.
@param LocalUserNum the user to read the friends list of
@param Count the number of friends to read or zero for all
@param StartingAt the index of the friends list to start at (for pulling partial lists)
@return true if the read request was issued successfully, false otherwise

ReadOnlineStats Source code

Reads a set of stats for the specified list of players
@param Players the array of unique ids to read stats for
@param StatsRead holds the definitions of the tables to read the data from and results are copied into the specified object
@return TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsByRank Source code

Reads stats by ranking. This grabs the rows starting at StartIndex through NumToRead and places them in the StatsRead object.
@param StatsRead holds the definitions of the tables to read the data from and results are copied into the specified object
@param StartIndex the starting rank to begin reads at (1 for top)
@param NumToRead the number of rows to read (clamped at 100 underneath)
@return TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsByRankAroundPlayer Source code

Reads stats by ranking centered around a player. This grabs a set of rows above and below the player's current rank
@param LocalUserNum the local player having their stats being centered upon
@param StatsRead holds the definitions of the tables to read the data from and results are copied into the specified object
@param NumRows the number of rows to read above and below the player's rank
@return TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsForFriends Source code

Reads a player's stats and all of that player's friends stats for the specified set of stat views. This allows you to easily compare a player's stats to their friends.
@param LocalUserNum the local player having their stats and friend's stats read for
@param StatsRead holds the definitions of the tables to read the data from and results are copied into the specified object
@return TRUE if the call is successful, FALSE otherwise

ReadPlayerStorage Source code

Reads the online player storage data for a given local user If a valid storage device ID is specified then data is also read from that device and the newer version is kept.
@param LocalUserNum the user that we are reading the data for
@param PlayerStorage the object to copy the results to and contains the list of items to read
@param DeviceId optional ID for connected device to read from. -1 for no device
@return true if the call succeeds, false otherwise

ReadPlayerStorageForNetId Source code

Reads the online player storage data for a given net user
@param LocalUserNum the local user that is initiating the read
@param NetId the net user that we are reading the data for
@param PlayerStorage the object to copy the results to and contains the list of items to read
@return true if the call succeeds, false otherwise

ReadProfileSettings Source code

Reads the online profile settings for a given user
@param LocalUserNum the user that we are reading the data for
@param ProfileSettings the object to copy the results to and contains the list of items to read
@return true if the call succeeds, false otherwise

ReadTitleFile Source code

Starts an asynchronous read of the specified file from the network platform's title specific file store
@param FileToRead the name of the file to read
@return true if the calls starts successfully, false otherwise

RegisterHostStatGuid Source code

Registers the host's stat guid with the client for verification they are part of the stat. Note this is an async task for any backend communication that needs to happen before the registration is deemed complete
@param HostStatGuid the host's stat guid
@return TRUE if the call is successful, FALSE otherwise

RegisterLocalTalker Source code

Registers the user as a talker
@param LocalUserNum the local player index that is a talker
@return TRUE if the call succeeded, FALSE otherwise

RegisterRemoteTalker Source code

Registers a remote player as a talker
@param PlayerId the unique id of the remote player that is a talker
@return TRUE if the call succeeded, FALSE otherwise

RegisterStatGuid Source code

Registers the client's stat guid on the host to validate that the client was in the stat. Used for synching up stats. Only valid on the host.
@param PlayerId the client's unique net id
@param ClientStatGuid the client's stat guid
@return TRUE if the call is successful, FALSE otherwise

RemoveFriend Source code

Removes a friend from the player's friend list
@param LocalUserNum the user that is removing the friend
@param FormerFriend the player to remove from the friend list
@return true if successful, false otherwise

SelectVocabulary Source code

Changes the vocabulary id that is currently being used
@param LocalUserNum the local user that is making the change
@param VocabularyId the new id to use
@return true if successful, false otherwise

SendGameInviteToFriend Source code

Sends an invitation to play in the player's current session
@param LocalUserNum the user that is sending the invite
@param Friend the player to send the invite to
@param Text the text of the message for the invite
@return true if successful, false otherwise

SendGameInviteToFriends Source code

Sends invitations to play in the player's current session
@param LocalUserNum the user that is sending the invite
@param Friends the player to send the invite to
@param Text the text of the message for the invite
@return true if successful, false otherwise

SendMessageToFriend Source code

Sends a message to a friend
@param LocalUserNum the user that is sending the message
@param Friend the player to send the message to
@param Message the message to display to the recipient
@return true if successful, false otherwise

SetNetworkNotificationPosition Source code

Sets a new position for the network notification icons/images
@param NewPos the new location to use

SetOnlineStatus Source code

Sets the online status information to use for the specified player. Used to tell other players what the player is doing (playing, menus, away, etc.)
@param LocalUserNum the controller number of the associated user
@param StatusId the status id to use (maps to strings where possible)
@param LocalizedStringSettings the list of localized string settings to set
@param Properties the list of properties to set

SetRemoteTalkerPriority Source code

Sets the relative priority for a remote talker. 0 is highest
@param LocalUserNum the user that controls the relative priority
@param PlayerId the remote talker that is having their priority changed for
@param Priority the relative priority to use (0 highest, < 0 is muted)
@return TRUE if the function succeeds, FALSE otherwise

SetSpeechRecognitionObject Source code

Changes the object that is in use to the one specified
@param LocalUserNum the local user that is making the change
@param SpeechRecogObj the new object use
@param true if successful, false otherwise

ShowFriendsUI Source code

Displays the UI that shows a user's list of friends
@param LocalUserNum the controller number of the associated user
@return TRUE if it was able to show the UI, FALSE if it failed

ShowKeyboardUI Source code

Displays the UI that shows the keyboard for inputing text
@param LocalUserNum the controller number of the associated user
@param TitleText the title to display to the user
@param DescriptionText the text telling the user what to input
@param bIsPassword whether the item being entered is a password or not
@param bShouldValidate whether to apply the string validation API after input or not
@param DefaultText the default string to display
@param MaxResultLength the maximum length string expected to be filled in
@return TRUE if it was able to show the UI, FALSE if it failed

ShowLoginUI Source code

Displays the UI that prompts the user for their login credentials. Each platform handles the authentication of the user's data.
@param bShowOnlineOnly whether to only display online enabled profiles or not
@return TRUE if it was able to show the UI, FALSE if it failed

StartNetworkedVoice Source code

Tells the voice layer that networked processing of the voice data is allowed for the specified player. This allows for push-to-talk style voice communication
@param LocalUserNum the local user to allow network transimission for

StartSpeechRecognition Source code

Tells the voice system to start tracking voice data for speech recognition
@param LocalUserNum the local user to recognize voice data for
@return true upon success, false otherwise

StopNetworkedVoice Source code

Tells the voice layer to stop processing networked voice support for the specified player. This allows for push-to-talk style voice communication
@param LocalUserNum the local user to disallow network transimission for

StopSpeechRecognition Source code

Tells the voice system to stop tracking voice data for speech recognition
@param LocalUserNum the local user to recognize voice data for
@return true upon success, false otherwise

UnlockAchievement Source code

Unlocks the specified achievement for the specified user
@param LocalUserNum the controller number of the associated user
@param AchievementId the id of the achievement to unlock
@return TRUE if the call worked, FALSE otherwise

UnmuteAll Source code

Allows all speakers to send voice
@param LocalUserNum the local user that is making the change

UnmuteRemoteTalker Source code

Allows a remote talker to talk to the specified local player. NOTE: This only unmutes them in the game unless the bIsSystemWide flag is true, which attempts to unmute them globally
@param LocalUserNum the user that is allowing the remote talker to talk
@param PlayerId the remote talker that is being restored to talking
@param bIsSystemWide whether to try to unmute them globally or not
@return TRUE if the function succeeds, FALSE otherwise

UnregisterLocalTalker Source code

Unregisters the user as a talker
@param LocalUserNum the local player index to be removed
@return TRUE if the call succeeded, FALSE otherwise

UnregisterRemoteTalker Source code

Unregisters a remote player as a talker
@param PlayerId the unique id of the remote player to be removed
@return TRUE if the call succeeded, FALSE otherwise

WriteOnlinePlayerScores Source code

Writes the score data for the match
@param SessionName the name of the session to write scores for
@param LeaderboardId the leaderboard to write the score information to
@param PlayerScores the list of players, teams, and scores they earned
@return TRUE if the call is successful, FALSE otherwise

WriteOnlineStats Source code

Writes out the stats contained within the stats write object to the online subsystem's cache of stats data. Note the new data replaces the old. It does not write the data to the permanent storage until a FlushOnlineStats() call or a session ends. Stats cannot be written without a session or the write request is ignored. No more than 5 stats views can be written to at a time or the write request is ignored.
@param SessionName the name of the session to write stats for
@param Player the player to write stats for
@param StatsWrite the object containing the information to write
@return TRUE if the call is successful, FALSE otherwise

WritePlayerStorage Source code

Writes the online player storage data for a given local user to the online data store If a valid storage device ID is specified then data is also written to that device.
@param LocalUserNum the user that we are writing the data for
@param PlayerStorage the object that contains the list of items to write
@param DeviceId optional ID for connected device to write to. -1 for no device
@return true if the call succeeds, false otherwise

WriteProfileSettings Source code

Writes the online profile settings for a given user to the online data store
@param LocalUserNum the user that we are writing the data for
@param ProfileSettings the list of settings to write out
@return true if the call succeeds, false otherwise

defaultproperties
{
	LoggedInPlayerName="Player1"
}