Skip to content

Achievements

The Achievements feature provides access to Steam achievements for the currently logged-in user.

It can be used to read achievement state and metadata, unlock or clear achievements, display Steam achievement progress notifications, and retrieve achievement icons for use in your UI.

Achievements must first be created and configured in Steamworks before they can be used by the game.

Main Capabilities

  • Retrieve a single achievement by ID or index
  • Retrieve all achievements for the current user
  • Check whether an achievement is unlocked or hidden
  • Unlock an achievement
  • Clear an achievement
  • Display Steam's achievement progress notification
  • Read the achievement unlock date and time
  • Read localized achievement names and descriptions
  • Retrieve achievement icon textures

Basic Workflow

A typical achievement workflow is:

  1. Create the achievement in Steamworks and note its API Name.
  2. Use that API Name as the Achievement ID in the plugin.
  3. Unlock the achievement when the corresponding gameplay condition is met.
  4. Handle the success or failure callback.
  5. Query the achievement state when needed for gameplay or UI.

For Steamworks configuration, see Steamworks Setup.

For practical Blueprint workflows, see Examples.

Achievement Data

Achievement queries return FSteamAchievement, which contains:

  • Achievement ID
  • Unlocked state
  • Hidden state
  • Unlock date and time
  • Localized display name
  • Localized description

The unlock date and time can also be queried separately through FSteamAchievementDateTime.

Achievement Progress

Indicate Steam Achievement Progress displays Steam's built-in achievement progress notification.

This is useful for achievements that track visible progress, for example:

  • 25 / 100 Enemies Defeated
  • 3 / 10 Collectibles Found

This function only displays the progress notification. It does not store progress and does not unlock the achievement automatically.

Your game is responsible for tracking the actual progress and calling Unlock Steam Achievement when the achievement condition is complete.

Important Notes

  • Achievement IDs must match the API Name configured in Steamworks.
  • Achievements must exist in Steamworks before they can be queried or unlocked.
  • Achievement names and descriptions are provided by Steam and may be localized for the current Steam language.
  • Clear Steam Achievement is mainly useful during development and testing.
  • Achievement progress notifications are visual only; progress persistence remains the responsibility of your game.