Stay organized with collections
Save and categorize content based on your preferences.
GooglePlayGames.BasicApi.Achievement
Data interface for retrieving achievement information.
Summary
There are 3 states an achievement can be in:
Hidden - indicating the name and description of the achievement is not visible to the player.
Revealed - indicating the name and description of the achievement is visible to the player. Unlocked - indicating the player has unlocked, or achieved, the achievment.
Achievements has two types, standard which is unlocked in one step, and incremental, which require multiple steps to unlock.
Properties
|
CurrentSteps
|
int
The number of steps the user has gone towards unlocking this achievement.
|
Description
|
string
The description of this achievement.
|
Id
|
string
The ID string of this achievement.
|
IsIncremental
|
bool
Indicates whether this achievement is incremental.
|
IsRevealed
|
bool
Indicates whether the achievement is revealed or not (hidden).
|
IsUnlocked
|
bool
Indicates whether the achievement is unlocked or not.
|
LastModifiedTime
|
DateTime
The date and time the state of the achievement was modified.
|
Name
|
string
The name of this achievement.
|
Points
|
ulong
The number of experience points earned for unlocking this Achievement. |
RevealedImageUrl
|
string
The URL to the image to display when the achievement is revealed.
|
TotalSteps
|
int
The total number of steps needed to unlock this achievement.
|
UnlockedImageUrl
|
string
The URL to the image to display when the achievement is unlocked.
|
Public functions
|
ToString()
|
override string
|
Properties
CurrentSteps
int CurrentSteps
The number of steps the user has gone towards unlocking this achievement.
Description
string Description
The description of this achievement.
Id
string Id
The ID string of this achievement.
IsIncremental
bool IsIncremental
Indicates whether this achievement is incremental.
IsRevealed
bool IsRevealed
Indicates whether the achievement is revealed or not (hidden).
IsUnlocked
bool IsUnlocked
Indicates whether the achievement is unlocked or not.
LastModifiedTime
DateTime LastModifiedTime
The date and time the state of the achievement was modified.
The value is invalid (-1 long) if the achievement state has never been updated.
Name
string Name
The name of this achievement.
Points
ulong Points
The number of experience points earned for unlocking this Achievement.
RevealedImageUrl
string RevealedImageUrl
The URL to the image to display when the achievement is revealed.
TotalSteps
int TotalSteps
The total number of steps needed to unlock this achievement.
UnlockedImageUrl
string UnlockedImageUrl
The URL to the image to display when the achievement is unlocked.
Public functions
Achievement
Achievement()
ToString
override string ToString()
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-07-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-08 UTC."],[],[],null,["# GooglePlayGames.BasicApi.Achievement Class Reference\n\nGooglePlayGames.BasicApi.Achievement\n====================================\n\nData interface for retrieving achievement information.\n\nSummary\n-------\n\nThere are 3 states an achievement can be in:\n\nHidden - indicating the name and description of the achievement is not visible to the player.\n\nRevealed - indicating the name and description of the achievement is visible to the player. Unlocked - indicating the player has unlocked, or achieved, the achievment.\n\nAchievements has two types, standard which is unlocked in one step, and incremental, which require multiple steps to unlock.\n\n| ### Constructors and Destructors ||\n|---|---|\n| [Achievement](#class_google_play_games_1_1_basic_api_1_1_achievement_1a1193041cda991247f0486ad4029cfd0f)`()` ||\n\n| ### Properties ||\n|---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [CurrentSteps](#class_google_play_games_1_1_basic_api_1_1_achievement_1aea9db469548bd48be786748cd87aaad8) | `int` The number of steps the user has gone towards unlocking this achievement. |\n| [Description](#class_google_play_games_1_1_basic_api_1_1_achievement_1a0f78cafc13451ddc8e2a29c7e801012c) | `string` The description of this achievement. |\n| [Id](#class_google_play_games_1_1_basic_api_1_1_achievement_1abf4691050479270c816ffff02713931a) | `string` The ID string of this achievement. |\n| [IsIncremental](#class_google_play_games_1_1_basic_api_1_1_achievement_1aee0b644e3e172d7888a56c9d6216c8da) | `bool` Indicates whether this achievement is incremental. |\n| [IsRevealed](#class_google_play_games_1_1_basic_api_1_1_achievement_1a66525357f78e550f0d3e0cf8a68c449e) | `bool` Indicates whether the achievement is revealed or not (hidden). |\n| [IsUnlocked](#class_google_play_games_1_1_basic_api_1_1_achievement_1aecc9cc9f855dd45dda6a0f02838db05b) | `bool` Indicates whether the achievement is unlocked or not. |\n| [LastModifiedTime](#class_google_play_games_1_1_basic_api_1_1_achievement_1a79268bc334d62d884ebed7d10e814cf0) | `DateTime` The date and time the state of the achievement was modified. |\n| [Name](#class_google_play_games_1_1_basic_api_1_1_achievement_1a67c30fdc0e4cd601f01ee54b9a2d5ece) | `string` The name of this achievement. |\n| [Points](#class_google_play_games_1_1_basic_api_1_1_achievement_1aeae19820a01eae718f966cd521b299de) | `ulong` The number of experience points earned for unlocking this [Achievement](/games/services/unity/v2/api/class/google-play-games/basic-api/achievement#class_google_play_games_1_1_basic_api_1_1_achievement). |\n| [RevealedImageUrl](#class_google_play_games_1_1_basic_api_1_1_achievement_1a882d2ab5a3f29fd72310fb96edea0e69) | `string` The URL to the image to display when the achievement is revealed. |\n| [TotalSteps](#class_google_play_games_1_1_basic_api_1_1_achievement_1a7dfc4adc76dbe76c71204906caaf754d) | `int` The total number of steps needed to unlock this achievement. |\n| [UnlockedImageUrl](#class_google_play_games_1_1_basic_api_1_1_achievement_1ac97eb8b768076ebef515fb55bf406c70) | `string` The URL to the image to display when the achievement is unlocked. |\n\n| ### Public functions ||\n|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [ToString](#class_google_play_games_1_1_basic_api_1_1_achievement_1a34080a315bf18bdbc7d2947cc655aa06)`()` | `override string` Returns a System.String that represents the current [GooglePlayGames.BasicApi.Achievement](/games/services/unity/v2/api/class/google-play-games/basic-api/achievement#class_google_play_games_1_1_basic_api_1_1_achievement). |\n\nProperties\n----------\n\n### CurrentSteps\n\n```c#\nint CurrentSteps\n``` \nThe number of steps the user has gone towards unlocking this achievement. \n\n### Description\n\n```c#\nstring Description\n``` \nThe description of this achievement. \n\n### Id\n\n```c#\nstring Id\n``` \nThe ID string of this achievement. \n\n### IsIncremental\n\n```c#\nbool IsIncremental\n``` \nIndicates whether this achievement is incremental. \n\n### IsRevealed\n\n```c#\nbool IsRevealed\n``` \nIndicates whether the achievement is revealed or not (hidden). \n\n### IsUnlocked\n\n```c#\nbool IsUnlocked\n``` \nIndicates whether the achievement is unlocked or not. \n\n### LastModifiedTime\n\n```c#\nDateTime LastModifiedTime\n``` \nThe date and time the state of the achievement was modified.\n\nThe value is invalid (-1 long) if the achievement state has never been updated. \n\n### Name\n\n```c#\nstring Name\n``` \nThe name of this achievement. \n\n### Points\n\n```c#\nulong Points\n``` \nThe number of experience points earned for unlocking this [Achievement](/games/services/unity/v2/api/class/google-play-games/basic-api/achievement#class_google_play_games_1_1_basic_api_1_1_achievement). \n\n### RevealedImageUrl\n\n```c#\nstring RevealedImageUrl\n``` \nThe URL to the image to display when the achievement is revealed. \n\n### TotalSteps\n\n```c#\nint TotalSteps\n``` \nThe total number of steps needed to unlock this achievement. \n\n### UnlockedImageUrl\n\n```c#\nstring UnlockedImageUrl\n``` \nThe URL to the image to display when the achievement is unlocked.\n\nPublic functions\n----------------\n\n### Achievement\n\n```c#\n Achievement()\n``` \n\n### ToString\n\n```c#\noverride string ToString()\n``` \nReturns a System.String that represents the current [GooglePlayGames.BasicApi.Achievement](/games/services/unity/v2/api/class/google-play-games/basic-api/achievement#class_google_play_games_1_1_basic_api_1_1_achievement).\n\n\u003cbr /\u003e\n\n| Details ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Returns** | A System.String that represents the current [GooglePlayGames.BasicApi.Achievement](/games/services/unity/v2/api/class/google-play-games/basic-api/achievement#class_google_play_games_1_1_basic_api_1_1_achievement). |"]]
