UE3:OnlineNewsInterface (UDK)

Interface >> OnlineNewsInterface

Package: 

Engine

Known implementing classes:

OnlineNewsInterfaceMcp

This interface in other games:

UT3

This interface provides functions for reading game specific news and announcements

Delegates

OnReadNewsCompleted

delegate OnReadNewsCompleted (bool bWasSuccessful, OnlineSubsystem.EOnlineNewsType NewsType)

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

Parameters:

• bWasSuccessful - true if the read completed ok, false otherwise
• NewsType - the type of news this callback is for

Instance functions

AddReadNewsCompletedDelegate

function AddReadNewsCompletedDelegate (delegate<OnReadNewsCompleted> ReadNewsDelegate)

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

Parameters:

• ReadNewsDelegate - the delegate to use for notifications

ClearReadNewsCompletedDelegate

function ClearReadNewsCompletedDelegate (delegate<OnReadNewsCompleted> ReadNewsDelegate)

Removes the specified delegate from the notification list

Parameters:

• ReadNewsDelegate - the delegate to use for notifications

GetNews

function string GetNews (byte LocalUserNum, OnlineSubsystem.EOnlineNewsType NewsType)

Returns the game specific news from the cache

Parameters:

• LocalUserNum - the local user the news is being read for
• NewsType - the type of news to read

Returns:

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

ReadNews

function bool ReadNews (byte LocalUserNum, OnlineSubsystem.EOnlineNewsType NewsType)

Reads the game specific news from the online subsystem

Parameters:

• LocalUserNum - the local user the news is being read for
• NewsType - the type of news to read

Returns:

true if the async task was successfully started, false otherwise