Achievements configuration options - AWS GameKit

You are currently viewing content for use with Unreal Engine software. See all AWS GameKit documentation

Achievements configuration options

The configuration for your achievement game feature includes compiling your game's achievement definitions. When defining an achievement, you can specify the following characteristics:

  • Unique name for the achievement. (Required)

  • Player-facing achievement name.

  • Player-facing achievement description. You can provide separate description strings for locked and unlocked states. When a game client requests achievement information for a player, AWS GameKit returns the string based on whether or not the player has earned the achievement.

  • URL for a player-facing image or icon. You can provide separate URLs for locked and unlocked states. When a game client requests achievement information for a player, AWS GameKit returns the URL based on whether or not the player has earned the achievement.

  • Maximum value. This is the numeric value that must be reached for a player to earn the achievement. For stateless achievements that require a single event to earn the achievement, this value might be set at 1. For stateful achievements that track progression toward the achievement, this value sets the required number, such as 1000 (for an achievement like "Ate 1000 bananas"). (Required)

  • Points awarded. If the achievement awards game points when the achievement is earned, this value indicates the number of points given to a player.

  • The Is_stateful flag indicates if the achievement is stateful (true) or stateless (false). This flag determines how the backend service evaluates the player's current status to determine whether the player has earned the achievement.

  • The Is_secret flag indicates when a game client can get the achievement information. When this flag is set to true, information and player status is returned only if the player has earned the achievement.

  • The Is_hidden flag indicates when the achievement can be used in the game. When this flag is set to true, no information is returned for this achievement and player status can't be updated.

  • Sort order number. This optional value indicates the order in which achievement information is returned when requested. It can be used to determine how achievements are listed in a game client display.