There is no spoon

UE3:OnlineNewsInterface (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Revision as of 16:11, 17 May 2008 by Wormbo (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UT3 Interface >> OnlineNewsInterface

Contents
Package: 
Engine
Known implementing classes:
OnlineSubsystemGameSpy
This interface in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

This interface provides functions for reading game specific news and announcements

[edit] Delegates

[edit] 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

[edit] 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

[edit] Instance functions

[edit] 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

[edit] 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

[edit] ClearReadContentAnnouncementsCompletedDelegate

function ClearReadContentAnnouncementsCompletedDelegate (delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate)

Removes the specified delegate from the notification list

Parameters:

  • ReadContentAnnouncementsDelegate - the delegate to use for notifications

[edit] ClearReadGameNewsCompletedDelegate

function ClearReadGameNewsCompletedDelegate (delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate)

Removes the specified delegate from the notification list

Parameters:

  • ReadGameNewsDelegate - the delegate to use for notifications

[edit] 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

[edit] 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

[edit] 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

[edit] 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
Retrieved from "http://wiki.beyondunreal.com/UE3:OnlineNewsInterface_(UT3)"