AchievementData

public struct AchievementData

Represents a Steam Achievement

Fields and Attributes

Api Name

public string ApiName { get; }

The unique ID of the achievement is the API Name that has been set in the Steamworks portal.


Description

public string Description { get; }

Returns the description of the achievement as seen by this user, which will depend on the user's language and the language configuration of the achievement


Global Percent

public float GlobalPercent { get; }

The percentage of users who have unlocked this achievement


Hidden

Returns the Is Hidden value of this achievement as seen by this user


Is Achieved

Indicates that this achievement has been unlocked by this user.

Only available on client builds


Name

Returns the name of the achievement as seen by this user; this will depend on the user's language and the language configuration of the achievement


Scriptable Object

The ScriptableObject representation of this Achievement if one exists and is registered to the active Heathen.SteamworksIntegration.SteamSettings object


Unlock Time

Indicates the time the achievement was unlocked if at all


Funcitons

Clear Achievement

Resets the unlock status of an achievement or clears the achievement for the user.


Compare To

Compares one achievement to another or to a string for the API name; this is an IComparable member.


Create ScriptableObject

This will create a ScriptableObject ... in general, you should not need this. The AchievementData struct has all the same features of the ScriptableObject but is much lighter weight and more suitable for creation at runtime.


Equals

True if the input equates to the AchievementData value as this. For object, we will try for a cast to AchievementData or string and for string, we check the API name.


Get

Get the achievement given the API name provided


Get Achievement and Unlock time

Get the unlock state and time for this achievement for a specific user.


Get Achievement Status

Gets the achievement status for the user


Get Hash Code

Returns a hash code value for this object


Get Icon

Gets the icon for this achievement as seen by the logged-in user; this will return either the locked or unlocked icon, depending on the state of the achievement for this user


Store

Request Steam client store the current state of all stats and achievements


To String

Returns the API Name of the achievement


Unlock

Unlocks the achievement for this user, or for game servers you can provide the user to unlock for. Note, you can only unlock for an achievement that is set to GS or GS Official, and only after authenticating the user and requesting that user's stats.


Operators

Assignment

Allows you to set an AchievementData from a string, or a string from an AchievementData.


Equality

Allows you to compare AchievementData and string values for equality.


Last updated