Choose your implementation method:
C
C#
This function is part of the Achievements Interface.
Remarks
Query for a list of achievements for a specific player, including progress towards completion for each achievement.
When the Social Overlay is enabled then this will be called automatically. The Social Overlay is enabled by default (see EOS_PF_DISABLE_SOCIAL_OVERLAY).
Return Value
EOS_Success if the operation completes successfully
EOS_Invalid_ProductUserID if any of the userid options are incorrect
EOS_InvalidParameters if any of the other options are incorrect
Parameters
EOS_Achievements_QueryPlayerAchievements
|
Parameter Type And Name |
Usage Information |
|---|---|
|
EOS_HAchievements Handle |
|
|
const EOS_Achievements_QueryPlayerAchievementsOptions* Options |
Structure containing information about the player whose achievements we're retrieving. |
|
void* ClientData |
Arbitrary data that is passed back to you in the CompletionDelegate |
|
const EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback CompletionDelegate |
This function is called when the query player achievements operation completes. |
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback to report the results of its operation. See the EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo page for more details, or check the Callback Data section below.
Callback Remarks
Function prototype definition for callbacks passed to EOS_Achievements_QueryPlayerAchievements
Callback Parameters
EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback
|
Parameter Type And Name |
Usage Information |
|---|---|
|
const EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo* Data |
An EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo containing the output information and result |
Callback Data
The EOS SDK passes the following data structure to the callback function:
EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo
|
Property |
Value |
|---|---|
|
EOS_EResult ResultCode |
The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. |
|
void* ClientData |
Context that was passed into EOS_Achievements_QueryPlayerAchievements. |
|
EOS_ProductUserId UserId |
The Product User ID of the user who initiated this request. |
For more information, see the EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo page.
Related API Members
This function is part of the Achievements Interface.
Remarks
Query for a list of achievements for a specific player, including progress towards completion for each achievement. {Result.InvalidProductUserID} if any of the userid options are incorrect {Result.InvalidParameters} if any of the other options are incorrect
When the Social Overlay is enabled then this will be called automatically. The Social Overlay is enabled by default (see EOS_PF_DISABLE_SOCIAL_OVERLAY).
Return Value
{Result.Success} if the operation completes successfully
Parameters
Achievements.AchievementsInterface.QueryPlayerAchievements
|
Parameter Type And Name |
Usage Information |
|---|---|
|
QueryPlayerAchievementsOptions options |
Structure containing information about the player whose achievements we're retrieving. |
|
object clientData |
Arbitrary data that is passed back to you in the CompletionDelegate |
|
OnQueryPlayerAchievementsCompleteCallback completionDelegate |
This function is called when the query player achievements operation completes. |
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Callback Function Information
Because this function is asynchronous, it employs a callback of type Achievements.OnQueryPlayerAchievementsCompleteCallback to report the results of its operation. See the Achievements.OnQueryPlayerAchievementsCompleteCallbackInfo page for more details, or check the Callback Data section below.
Callback Remarks
Function prototype definition for callbacks passed to {AchievementsInterface.QueryPlayerAchievements}
Callback Parameters
Achievements.OnQueryPlayerAchievementsCompleteCallback
|
Parameter Type And Name |
Usage Information |
|---|---|
|
OnQueryPlayerAchievementsCompleteCallbackInfo data |
An EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo containing the output information and result |
Callback Data
The EOS SDK passes the following data structure to the callback function:
Achievements.OnQueryPlayerAchievementsCompleteCallbackInfo
|
Property |
Value |
|---|---|
|
Result ResultCode |
The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. |
|
object ClientData |
Context that was passed into EOS_Achievements_QueryPlayerAchievements. |
|
ProductUserId UserId |
The Product User ID of the user who initiated this request. |
For more information, see the Achievements.OnQueryPlayerAchievementsCompleteCallbackInfo page.