| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||
| 00001 00002 00003 00004 00005 00006 00007 00008 00009 00010 00011 00012 00013 00014 00015 00016 00017 00018 00019 00020 00021 00022 00023 00024 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 00036 00037 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 00061 00062 00063 00064 00065 00066 00067 00068 00069 00070 00071 00072 00073 00074 00075 00076 00077 00078 00079 00080 00081 00082 00083 00084 00085 00086 00087 00088 00089 00090 00091 00092 00093 |
/** * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. */ /** * This interface provides functions for reading game specific news and announcements */ interface OnlineNewsInterface dependson(OnlineSubsystem); /** * Reads the game specific news from the online subsystem * * @param LocalUserNum the local user the news is being read for * * @return true if the async task was successfully started, false otherwise */ function bool ReadGameNews(byte LocalUserNum); /** * Delegate used in notifying the UI/game that the news read operation completed * * @param bWasSuccessful true if the read completed ok, false otherwise */ delegate OnReadGameNewsCompleted(bool bWasSuccessful); /** * Sets the delegate used to notify the gameplay code that news reading has completed * * @param ReadGameNewsDelegate the delegate to use for notifications */ function AddReadGameNewsCompletedDelegate(delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate); /** * Removes the specified delegate from the notification list * * @param ReadGameNewsDelegate the delegate to use for notifications */ function ClearReadGameNewsCompletedDelegate(delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate); /** * Returns the game specific news from the cache * * @param LocalUserNum the local user the news is being read for * * @return an empty string if no news was read, otherwise the contents of the read */ function string GetGameNews(byte LocalUserNum); /** * Reads the game specific content announcements from the online subsystem * * @param LocalUserNum the local user the request is for * * @return true if the async task was successfully started, false otherwise */ function bool ReadContentAnnouncements(byte LocalUserNum); /** * Delegate used in notifying the UI/game that the content announcements read operation completed * * @param bWasSuccessful true if the read completed ok, false otherwise */ delegate OnReadContentAnnouncementsCompleted(bool bWasSuccessful); /** * Sets the delegate used to notify the gameplay code that content announcements reading has completed * * @param ReadContentAnnouncementsDelegate the delegate to use for notifications */ function AddReadContentAnnouncementsCompletedDelegate(delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate); /** * Removes the specified delegate from the notification list * * @param ReadContentAnnouncementsDelegate the delegate to use for notifications */ function ClearReadContentAnnouncementsCompletedDelegate(delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate); /** * Returns the game specific content announcements from the cache * * @param LocalUserNum the local user the content announcements is being read for * * @return an empty string if no data was read, otherwise the contents of the read */ function string GetContentAnnouncements(byte LocalUserNum); defaultproperties { Name="Default__OnlineNewsInterface" ObjectArchetype=Interface'Core.Default__Interface' } |
| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||