UE3:OnlineNewsInterface (UT3)

Interface >> OnlineNewsInterface

Package:

Engine

Known implementing classes:

OnlineSubsystemGameSpy

This interface in other games:

UDK

This interface provides functions for reading game specific news and announcements

Delegates

OnReadContentAnnouncementsCompleted

delegate OnReadContentAnnouncementsCompleted (bool bWasSuccessful)

Delegate used in notifying the UI/game that the content announcements read operation completed

Parameters:

• bWasSuccessful - true if the read completed ok, false otherwise

OnReadGameNewsCompleted

delegate OnReadGameNewsCompleted (bool bWasSuccessful)

Delegate used in notifying the UI/game that the news read operation completed

Parameters:

• bWasSuccessful - true if the read completed ok, false otherwise

Instance functions

AddReadContentAnnouncementsCompletedDelegate

function AddReadContentAnnouncementsCompletedDelegate (delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate)

Sets the delegate used to notify the gameplay code that content announcements reading has completed

Parameters:

• ReadContentAnnouncementsDelegate - the delegate to use for notifications

AddReadGameNewsCompletedDelegate

function AddReadGameNewsCompletedDelegate (delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate)

Sets the delegate used to notify the gameplay code that news reading has completed

Parameters:

• ReadGameNewsDelegate - the delegate to use for notifications

ClearReadContentAnnouncementsCompletedDelegate

function ClearReadContentAnnouncementsCompletedDelegate (delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate)

Removes the specified delegate from the notification list

Parameters:

• ReadContentAnnouncementsDelegate - the delegate to use for notifications

ClearReadGameNewsCompletedDelegate

function ClearReadGameNewsCompletedDelegate (delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate)

Removes the specified delegate from the notification list

Parameters:

• ReadGameNewsDelegate - the delegate to use for notifications

GetContentAnnouncements

function string GetContentAnnouncements (byte LocalUserNum)

Returns the game specific content announcements from the cache

Parameters:

• LocalUserNum - the local user the content announcements is being read for

Returns:

an empty string if no data was read, otherwise the contents of the read

GetGameNews

function string GetGameNews (byte LocalUserNum)

Returns the game specific news from the cache

Parameters:

• LocalUserNum - the local user the news is being read for

Returns:

an empty string if no news was read, otherwise the contents of the read

ReadContentAnnouncements

function bool ReadContentAnnouncements (byte LocalUserNum)

Reads the game specific content announcements from the online subsystem

Parameters:

• LocalUserNum - the local user the request is for

Returns:

true if the async task was successfully started, false otherwise

ReadGameNews

function bool ReadGameNews (byte LocalUserNum)

Reads the game specific news from the online subsystem

Parameters:

• LocalUserNum - the local user the news is being read for

Returns:

true if the async task was successfully started, false otherwise