Gah - a solution with more questions. – EntropicLqd

UE3:OnlineContentInterface (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Interface >> OnlineContentInterface
Package: 
Engine
Known implementing classes:
OnlineSubsystemLive
This interface in other games:
UDK

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

Delegates[edit]

OnContentChange[edit]

delegate OnContentChange ()

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

OnQueryAvailableDownloadsComplete[edit]

delegate OnQueryAvailableDownloadsComplete (bool bWasSuccessful)

Called once the download query completes

Parameters:

  • bWasSuccessful - true if the async action completed without error, false if there was an error

OnReadContentComplete[edit]

delegate OnReadContentComplete (bool bWasSuccessful)

Delegate used when the content read request has completed

Parameters:

  • bWasSuccessful - true if the async action completed without error, false if there was an error

Instance functions[edit]

AddContentChangeDelegate[edit]

function AddContentChangeDelegate (delegate<OnContentChangeContentDelegate, optional byte LocalUserNum)

Adds the delegate used to notify the gameplay code that (downloaded) content changed

Parameters:

  • Content - Delegate the delegate to use for notifications
  • LocalUserNum - whether to watch for changes on a specific slot or all slots

AddQueryAvailableDownloadsComplete[edit]

function AddQueryAvailableDownloadsComplete (byte LocalUserNum, delegate<OnQueryAvailableDownloadsCompleteQueryDownloadsDelegate)

Adds the delegate used to notify the gameplay code that the content download query has completed

Parameters:

  • LocalUserNum - the user to check the content download availability for
  • ReadContentCompleteDelegate - the delegate to use for notifications

AddReadContentComplete[edit]

function AddReadContentComplete (byte LocalUserNum, delegate<OnReadContentCompleteReadContentCompleteDelegate)

Adds the delegate used to notify the gameplay code that the content read request has completed

Parameters:

  • LocalUserNum - The user to read the content list of
  • ReadContentCompleteDelegate - the delegate to use for notifications

ClearContentChangeDelegate[edit]

function ClearContentChangeDelegate (delegate<OnContentChangeContentDelegate, optional byte LocalUserNum)

Removes the delegate from the set of delegates that are notified

Parameters:

  • Content - Delegate the delegate to use for notifications
  • LocalUserNum - whether to watch for changes on a specific slot or all slots

ClearQueryAvailableDownloadsComplete[edit]

function ClearQueryAvailableDownloadsComplete (byte LocalUserNum, delegate<OnQueryAvailableDownloadsCompleteQueryDownloadsDelegate)

Clears the delegate used to notify the gameplay code that the content download query has completed

Parameters:

  • LocalUserNum - the user to check the content download availability for
  • ReadContentCompleteDelegate - the delegate to use for notifications

ClearReadContentComplete[edit]

function ClearReadContentComplete (byte LocalUserNum, delegate<OnReadContentCompleteReadContentCompleteDelegate)

Clears the delegate used to notify the gameplay code that the content read request has completed

Parameters:

  • LocalUserNum - The user to read the content list of
  • ReadContentCompleteDelegate - the delegate to use for notifications

GetAvailableDownloadCounts[edit]

function GetAvailableDownloadCounts (byte LocalUserNum, out int NewDownloads, out int TotalDownloads)

Returns the number of new and total downloads available for the user

Parameters:

  • LocalUserNum - the user to check the content download availability for
  • NewDownloads - out value of the number of new downloads available
  • TotalDownloads - out value of the number of total downloads available

GetContentList[edit]

function OnlineSubsystem.EOnlineEnumerationReadState GetContentList (byte LocalUserNum, out array<OnlineSubsystem.OnlineContentContentList)

Retrieve the list of content the given user has downloaded or otherwise retrieved to the local console.

Parameters:

  • LocalUserNum - The user to read the content list of
  • ContentList - The out array that receives the list of all content

Returns:

OERS_Done if the read has completed, otherwise one of the other states

QueryAvailableDownloads[edit]

function bool QueryAvailableDownloads (byte LocalUserNum)

Asks the online system for the number of new and total content downloads

Parameters:

  • LocalUserNum - the user to check the content download availability for

Returns:

TRUE if the call succeeded, FALSE otherwise

ReadContentList[edit]

function bool ReadContentList (byte LocalUserNum)

Starts an async task that retrieves the list of downloaded content for the player.

Parameters:

  • LocalUserNum - The user to read the content list of

Returns:

true if the read request was issued successfully, false otherwise