Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.OnlineContentInterface

Modifiers
dependson ( OnlineSubsystem )

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

Engine.OnlineContentInterface

Delegates Summary
delegate OnContentChange ()
delegate OnQueryAvailableDownloadsComplete (bool bWasSuccessful)
delegate OnReadContentComplete (bool bWasSuccessful)

Functions Summary
function AddContentChangeDelegate (delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum = 255)
function AddQueryAvailableDownloadsComplete (byte LocalUserNum, elegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate)
function AddReadContentComplete (byte LocalUserNum, elegate<OnReadContentComplete> ReadContentCompleteDelegate)
function ClearContentChangeDelegate (delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum = 255)
function ClearQueryAvailableDownloadsComplete (byte LocalUserNum, elegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate)
function ClearReadContentComplete (byte LocalUserNum, elegate<OnReadContentComplete> ReadContentCompleteDelegate)
function GetAvailableDownloadCounts (byte LocalUserNum, ut int NewDownloads, ut int TotalDownloads)
functionEOnlineEnumerationReadState GetContentList (byte LocalUserNum, out array<OnlineContent> ContentList)
functionbool QueryAvailableDownloads (byte LocalUserNum)
functionbool ReadContentList (byte LocalUserNum)


Delegates Detail

OnContentChange Source code

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

OnQueryAvailableDownloadsComplete Source code

delegate OnQueryAvailableDownloadsComplete ( bool bWasSuccessful )
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 OnReadContentComplete ( bool bWasSuccessful )
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


Functions Detail

AddContentChangeDelegate Source code

function AddContentChangeDelegate ( delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum = 255 )
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

function AddQueryAvailableDownloadsComplete ( byte LocalUserNum,delegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate )
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

function AddReadContentComplete ( byte LocalUserNum,delegate<OnReadContentComplete> ReadContentCompleteDelegate )
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 ReadContentCompleteDelegate the delegate to use for notifications

ClearContentChangeDelegate Source code

function ClearContentChangeDelegate ( delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum = 255 )
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

ClearQueryAvailableDownloadsComplete Source code

function ClearQueryAvailableDownloadsComplete ( byte LocalUserNum,delegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate )
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

function ClearReadContentComplete ( byte LocalUserNum,delegate<OnReadContentComplete> ReadContentCompleteDelegate )
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 ReadContentCompleteDelegate the delegate to use for notifications

GetAvailableDownloadCounts Source code

function GetAvailableDownloadCounts ( byte LocalUserNum,out int NewDownloads,out int TotalDownloads )
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

function EOnlineEnumerationReadState GetContentList ( byte LocalUserNum, out array<OnlineContent> ContentList )
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 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

QueryAvailableDownloads Source code

function bool QueryAvailableDownloads ( byte LocalUserNum )
Asks the online system for the number of new and total content downloads
@param LocalUserNum the user to check the content download availability for
@return TRUE if the call succeeded, FALSE otherwise

ReadContentList Source code

function bool ReadContentList ( byte LocalUserNum )
Starts an async task that retrieves the list of downloaded content for the player.
@param LocalUserNum The user to read the content list of
@return true if the read request was issued successfully, false otherwise


Defaultproperties

defaultproperties
{
   Name="Default__OnlineContentInterface"
   ObjectArchetype=Interface'Core.Default__Interface'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:40.073 - Created with UnCodeX