Engine.OnlineContentInterface

Modifiers

dependson ( OnlineSubsystem )

This interface provides accessors to the platform specific content system (ie downloadable content, etc)

Engine.OnlineContentInterface

Delegates Summary
		OnContentChange ()
		OnQueryAvailableDownloadsComplete (bool bWasSuccessful)
		OnReadContentComplete (bool bWasSuccessful)
		OnReadSaveGameDataComplete (bool bWasSuccessful, yte LocalUserNum, nt DeviceId, tring FriendlyName, tring FileName, tring SaveFileName)
		OnWriteSaveGameDataComplete (bool bWasSuccessful, yte LocalUserNum, nt DeviceId, tring FriendlyName, tring FileName, tring SaveFileName)

Functions Summary
		AddContentChangeDelegate (delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum = 255)
		AddQueryAvailableDownloadsComplete (byte LocalUserNum, elegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate)
		AddReadContentComplete (byte LocalUserNum, OnlineContentType ContentType, elegate<OnReadContentComplete> ReadContentCompleteDelegate)
		AddReadSaveGameDataComplete (byte LocalUserNum, elegate<OnReadSaveGameDataComplete> ReadSaveGameDataCompleteDelegate)
		AddWriteSaveGameDataComplete (byte LocalUserNum, elegate<OnWriteSaveGameDataComplete> WriteSaveGameDataCompleteDelegate)
		ClearContentChangeDelegate (delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum = 255)
		ClearContentList (byte LocalUserNum, OnlineContentType ContentType)
		ClearQueryAvailableDownloadsComplete (byte LocalUserNum, elegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate)
		ClearReadContentComplete (byte LocalUserNum, OnlineContentType ContentType, elegate<OnReadContentComplete> ReadContentCompleteDelegate)
		ClearReadSaveGameDataComplete (byte LocalUserNum, elegate<OnReadSaveGameDataComplete> ReadSaveGameDataCompleteDelegate)
	bool	ClearSaveGames (byte LocalUserNum)
		ClearWriteSaveGameDataComplete (byte LocalUserNum, elegate<OnWriteSaveGameDataComplete> WriteSaveGameDataCompleteDelegate)
	bool	DeleteSaveGame (byte LocalUserNum, nt DeviceId, tring FriendlyName, tring FileName)
		GetAvailableDownloadCounts (byte LocalUserNum, ut int NewDownloads, ut int TotalDownloads)
	EOnlineEnumerationReadState	GetContentList (byte LocalUserNum, OnlineContentType ContentType, ut array<OnlineContent> ContentList)
	bool	GetSaveGameData (byte LocalUserNum, nt DeviceId, tring FriendlyName, tring FileName, tring SaveFileName, ut array<byte> SaveGameData)
	bool	QueryAvailableDownloads (byte LocalUserNum, ptional int CategoryMask = -1)
	bool	ReadContentList (byte LocalUserNum, OnlineContentType ContentType, ptional int DeviceId = -1)
	bool	ReadSaveGameData (byte LocalUserNum, nt DeviceId, tring FriendlyName, tring FileName, tring SaveFileName)
	bool	WriteSaveGameData (byte LocalUserNum, nt DeviceId, tring FriendlyName, tring FileName, tring SaveFileName, onst out array<byte> SaveGameData)

OnContentChange Source code

Delegate used in content change (add or deletion) notifications for any user

OnQueryAvailableDownloadsComplete Source code

Called once the download query completes
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnReadContentComplete Source code

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

OnReadSaveGameDataComplete Source code

Delegate used when the content read request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error
@param LocalUserNum the user that was initiating the data read
@param DeviceId the device that the read was on
@param FriendlyName the friendly name of the save game that was returned by enumeration
@param FileName the file to read from inside of the content package
@param SaveFileName the file name of the save game inside the content package

OnWriteSaveGameDataComplete Source code

Delegate used when the content write request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error
@param LocalUserNum the user that was initiating the data write
@param DeviceId the device to write the same game to
@param FriendlyName the friendly name of the save game
@param FileName the file to write to inside of the content package
@param SaveGameData the data to write to the save game file

AddContentChangeDelegate Source code

Adds the delegate used to notify the gameplay code that (downloaded) content changed
@param Content Delegate the delegate to use for notifications
@param LocalUserNum whether to watch for changes on a specific slot or all slots

AddQueryAvailableDownloadsComplete Source code

Adds the delegate used to notify the gameplay code that the content download query has completed
@param LocalUserNum the user to check the content download availability for
@param ReadContentCompleteDelegate the delegate to use for notifications

AddReadContentComplete Source code

Adds the delegate used to notify the gameplay code that the content read request has completed
@param LocalUserNum The user to read the content list of
@param ContentType the type of content being read
@param ReadContentCompleteDelegate the delegate to use for notifications

AddReadSaveGameDataComplete Source code

Adds the delegate used to notify the gameplay code that a save game read request has completed
@param LocalUserNum The user that was reading a save game
@param ReadSaveGameDataCompleteDelegate the delegate to use for notifications

AddWriteSaveGameDataComplete Source code

Adds the delegate used to notify the gameplay code that a save game write request has completed
@param LocalUserNum The user that was writing a save game
@param WriteSaveGameDataCompleteDelegate the delegate to use for notifications

ClearContentChangeDelegate Source code

Removes the delegate from the set of delegates that are notified
@param Content Delegate the delegate to use for notifications
@param LocalUserNum whether to watch for changes on a specific slot or all slots

ClearContentList Source code

Starts an async task that frees any downloaded content resources for that player
@param LocalUserNum The user to clear the content list for
@param ContentType the type of content being read

ClearQueryAvailableDownloadsComplete Source code

Clears the delegate used to notify the gameplay code that the content download query has completed
@param LocalUserNum the user to check the content download availability for
@param ReadContentCompleteDelegate the delegate to use for notifications

ClearReadContentComplete Source code

Clears the delegate used to notify the gameplay code that the content read request has completed
@param LocalUserNum The user to read the content list of
@param ContentType the type of content being read
@param ReadContentCompleteDelegate the delegate to use for notifications

ClearReadSaveGameDataComplete Source code

Clears the delegate used to notify the gameplay code that a save game read request has completed
@param LocalUserNum The user that was reading a save game
@param ReadSaveGameDataCompleteDelegate the delegate to use for notifications

ClearSaveGames Source code

Clears any cached save games
@param LocalUserNum the user that is deleting data
@return true if the clear succeeded, false otherwise

ClearWriteSaveGameDataComplete Source code

Clears the delegate used to notify the gameplay code that a save game write request has completed
@param LocalUserNum The user that was writing a save game
@param WriteSaveGameDataCompleteDelegate the delegate to use for notifications

DeleteSaveGame Source code

Deletes a player's save game data
@param LocalUserNum the user that is deleting data
@param DeviceId the device to delete the same game from
@param FriendlyName the friendly name of the save game that was returned by enumeration
@param FileName the file name of the content package to delete
@return true if the delete succeeded, false otherwise

GetAvailableDownloadCounts Source code

Returns the number of new and total downloads available for the user
@param LocalUserNum the user to check the content download availability for
@param NewDownloads out value of the number of new downloads available
@param TotalDownloads out value of the number of total downloads available

GetContentList Source code

Retrieve the list of content the given user has downloaded or otherwise retrieved to the local console.
@param LocalUserNum The user to read the content list of
@param ContentType the type of content being read
@param ContentList The out array that receives the list of all content
@return OERS_Done if the read has completed, otherwise one of the other states

GetSaveGameData Source code

Copies a player's save game data from the cached async read data
@param LocalUserNum the user that is initiating the data read (also used in validating ownership of the data)
@param DeviceId the device to read the same game from
@param FriendlyName the friendly name of the save game that was returned by enumeration
@param FileName the file to read from inside of the content package
@param SaveFileName the file name of the save game inside the content package
@param SaveGameData the array that is filled with the save game data
@return true if the async read was started successfully, false otherwise

QueryAvailableDownloads Source code

Asks the online system for the number of new and total content downloads
@param LocalUserNum the user to check the content download availability for
@param CategoryMask the bitmask to use to filter content by type
@return TRUE if the call succeeded, FALSE otherwise

ReadContentList Source code

Starts an async task that retrieves the list of downloaded content for the player.
@param LocalUserNum The user to read the content list of
@param ContentType the type of content being read
@param DeviceId optional value to restrict the enumeration to a particular device
@return true if the read request was issued successfully, false otherwise

ReadSaveGameData Source code

Reads a player's save game data from the specified content bundle
@param LocalUserNum the user that is initiating the data read (also used in validating ownership of the data)
@param DeviceId the device to read the same game from
@param FriendlyName the friendly name of the save game that was returned by enumeration
@param FileName the file to read from inside of the content package
@param SaveFileName the file name of the save game inside the content package
@return true if the async read was started successfully, false otherwise

WriteSaveGameData Source code

Writes a player's save game data to the specified content bundle and file
@param LocalUserNum the user that is initiating the data write
@param DeviceId the device to write the same game to
@param FriendlyName the friendly name of the save game that was returned by enumeration
@param FileName the file name of the content package
@param SaveFileName the file name of the save game inside the content package
@param SaveGameData the data to write to the save game file
@return true if the async write was started successfully, false otherwise