This function is part of the Achievements Interface.
Register to receive achievement unlocked notifications.
must call EOS_Achievements_RemoveNotifyAchievementsUnlocked to remove the notification
Return Value
handle representing the registered callback
See Also
EOS_Achievements_RemoveNotifyAchievementsUnlocked
Parameters
Achievements.AchievementsInterface.AddNotifyAchievementsUnlockedV2
Parameter Type And Name
|
Usage Information
|
AddNotifyAchievementsUnlockedV2Options options
|
Structure containing information about the achievement unlocked notification
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
OnAchievementsUnlockedCallbackV2 notificationFn
|
A callback that is fired when an achievement unlocked notification for a user has been received
|
This function enables your callback (the NotificationFn
parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.
Because this function is asynchronous, it employs a callback of type EOS_Achievements_OnAchievementsUnlockedCallbackV2 to report the results of its operation. See the EOS_Achievements_OnAchievementsUnlockedCallbackV2Info page for more details, or check the Callback Data section below.
Function prototype definition for notifications that come from EOS_Achievements_AddNotifyAchievementsUnlockedV2
Callback Parameters
Achievements.OnAchievementsUnlockedCallbackV2
Parameter Type And Name
|
Usage Information
|
OnAchievementsUnlockedCallbackV2Info data
|
An EOS_Achievements_OnAchievementsUnlockedCallbackV2Info containing the output information and result
|
Callback Data
The EOS SDK passes the following data structure to the callback function:
Achievements.OnAchievementsUnlockedCallbackV2Info
Property
|
Value
|
object ClientData
|
Context that was passed into EOS_Achievements_AddNotifyAchievementsUnlocked
|
ProductUserId UserId
|
The Product User ID for the user who received the unlocked achievements notification
|
string AchievementId
|
The Achievement ID for the achievement that was unlocked. Pass this to EOS_Achievements_CopyPlayerAchievementByAchievementId to get the full achievement information.
|
System.DateTimeOffset? UnlockTime
|
POSIX timestamp when the achievement was unlocked.
|
For more information, see the EOS_Achievements_OnAchievementsUnlockedCallbackV2Info page.