Implementation of the IOnlineAchievements interface for the OnlineSubsystem.
- See also
- IOnlineAchievements
#include <OnlineAchievementsOmni.h>
Inherits IOnlineAchievements.
|
| virtual void | WriteAchievements (const FUniqueNetId &PlayerId, FOnlineAchievementsWriteRef &WriteObject, const FOnAchievementsWrittenDelegate &Delegate=FOnAchievementsWrittenDelegate()) override |
| | Write the achievements provided to the server.
|
| |
| virtual void | QueryAchievements (const FUniqueNetId &PlayerId, const FOnQueryAchievementsCompleteDelegate &Delegate=FOnQueryAchievementsCompleteDelegate()) override |
| | Read achievement ids and their progress from the server.
|
| |
| virtual void | QueryAchievementDescriptions (const FUniqueNetId &PlayerId, const FOnQueryAchievementsCompleteDelegate &Delegate=FOnQueryAchievementsCompleteDelegate()) override |
| | Read achievement descriptions from the server for displaying achievements in game.
|
| |
| virtual EOnlineCachedResult::Type | GetCachedAchievement (const FUniqueNetId &PlayerId, const FString &AchievementId, FOnlineAchievement &OutAchievement) override |
| | Get an achievement object which was previously synced from the server.
|
| |
| virtual EOnlineCachedResult::Type | GetCachedAchievements (const FUniqueNetId &PlayerId, TArray< FOnlineAchievement > &OutAchievements) override |
| | Get all the achievement objects for the specified player.
|
| |
| virtual EOnlineCachedResult::Type | GetCachedAchievementDescription (const FString &AchievementId, FOnlineAchievementDesc &OutAchievementDesc) override |
| | Get the achievement description object for the specified achievement id.
|
| |
|
virtual bool | ResetAchievements (const FUniqueNetId &PlayerId) override |
| | Not Supported.
|
| |
◆ GetCachedAchievement()
| virtual EOnlineCachedResult::Type FOnlineAchievementsOmni::GetCachedAchievement |
( |
const FUniqueNetId & |
PlayerId, |
|
|
const FString & |
AchievementId, |
|
|
FOnlineAchievement & |
OutAchievement |
|
) |
| |
|
overridevirtual |
Get an achievement object which was previously synced from the server.
- Parameters
-
| PlayerId | - The uid of the player we are reading achievements for |
| AchievementId | - The id of the achievement we are looking up |
| OutAchievement | - The achievement object we are searching for. Untouched if not found. |
- Returns
- Whether achievements were obtained
◆ GetCachedAchievementDescription()
| virtual EOnlineCachedResult::Type FOnlineAchievementsOmni::GetCachedAchievementDescription |
( |
const FString & |
AchievementId, |
|
|
FOnlineAchievementDesc & |
OutAchievementDesc |
|
) |
| |
|
overridevirtual |
Get the achievement description object for the specified achievement id.
- Parameters
-
| AchievementId | - The id of the achievement we are searching for data of |
| OutAchievementDesc | - The description object for the achievement id we seek. Untouched if not found. |
- Returns
- Whether achievements were obtained
◆ GetCachedAchievements()
| virtual EOnlineCachedResult::Type FOnlineAchievementsOmni::GetCachedAchievements |
( |
const FUniqueNetId & |
PlayerId, |
|
|
TArray< FOnlineAchievement > & |
OutAchievements |
|
) |
| |
|
overridevirtual |
Get all the achievement objects for the specified player.
- Parameters
-
| PlayerId | - The uid of the player we are reading achievements for |
| OutAchievements | - The collection of achievements obtained from the server for the given player. Untouched if not found. |
- Returns
- Whether achievements were obtained
◆ QueryAchievementDescriptions()
| virtual void FOnlineAchievementsOmni::QueryAchievementDescriptions |
( |
const FUniqueNetId & |
PlayerId, |
|
|
const FOnQueryAchievementsCompleteDelegate & |
Delegate = FOnQueryAchievementsCompleteDelegate() |
|
) |
| |
|
overridevirtual |
Read achievement descriptions from the server for displaying achievements in game.
- See also
- FOnlineAchievementDesc
- Parameters
-
| PlayerId | the id of the player we are reading achievements for |
| Delegate | the delegate to trigger when the query is complete |
◆ QueryAchievements()
| virtual void FOnlineAchievementsOmni::QueryAchievements |
( |
const FUniqueNetId & |
PlayerId, |
|
|
const FOnQueryAchievementsCompleteDelegate & |
Delegate = FOnQueryAchievementsCompleteDelegate() |
|
) |
| |
|
overridevirtual |
Read achievement ids and their progress from the server.
You must use QueryAchievementDescriptions to get more information about the achievements
- See also
- QueryAchievementDescriptions
- Parameters
-
| PlayerId | the id of the player we are reading achievements for |
| Delegate | the delegate to trigger when the query is complete |
◆ WriteAchievements()
| virtual void FOnlineAchievementsOmni::WriteAchievements |
( |
const FUniqueNetId & |
PlayerId, |
|
|
FOnlineAchievementsWriteRef & |
WriteObject, |
|
|
const FOnAchievementsWrittenDelegate & |
Delegate = FOnAchievementsWrittenDelegate() |
|
) |
| |
|
overridevirtual |
Write the achievements provided to the server.
- Parameters
-
| PlayerId | - The uid of the player we are writing achievements for |
| WriteObject | - The stats holder containing the achievements we are writing to. |
| Delegate | - The delegate to call when the write has completed or failed. |
1.9.8