AchievementDefinition14.1

Class in Unbroken.LaunchBox.Plugins.Components.Achievements

public sealed class AchievementDefinition

Defines one achievement independently of account progress.

Constructors

AchievementDefinitionCreates an achievement definition.

AchievementDefinition

public AchievementDefinition(string achievementId, string name)

Creates an achievement definition.

achievementId: Opaque source-local achievement ID.

name: Provider-returned achievement title.

Properties

AchievementIdGets the source-local achievement ID.
AdditionalDataGets or initializes provider-specific scalar observations that have no corresponding typed achievement property.
DescriptionGets or initializes the description.
DisplayOrderGets or initializes provider display ordering.
IsHiddenGets or initializes whether locked details should be concealed.
KindGets or initializes list classification.
LockedIconUrlGets or initializes locked artwork.
NameGets the returned title.
PointsGets or initializes the optional points value.
RarityPercentGets or initializes unlock rarity, from zero through one hundred.
UnlockedIconUrlGets or initializes unlocked artwork.
WebUriGets or initializes an achievement web page.

AchievementId

public string AchievementId { get; }

Gets the source-local achievement ID.

AdditionalData

public IReadOnlyDictionary<string, string> AdditionalData { get; init; }

Gets or initializes provider-specific scalar observations that have no corresponding typed achievement property.

Remarks

Empty by default. Values are copied into a read-only snapshot with ordinal, case-sensitive keys. Keys use documented source-ID prefixes followed by a dot, such as retroachievements.retro-points. Values retain their supplied text; absent keys mean unavailable data, while an empty string represents an observed empty value. These observations do not replace typed properties or represent a user's unlock progress.

Description

public string? Description { get; init; }

Gets or initializes the description.

DisplayOrder

public int DisplayOrder { get; init; }

Gets or initializes provider display ordering.

IsHidden

public bool IsHidden { get; init; }

Gets or initializes whether locked details should be concealed.

Kind

public AchievementKind Kind { get; init; }

Gets or initializes list classification.

LockedIconUrl

public string? LockedIconUrl { get; init; }

Gets or initializes locked artwork.

Name

public string Name { get; }

Gets the returned title.

Points

public int? Points { get; init; }

Gets or initializes the optional points value.

RarityPercent

public double? RarityPercent { get; init; }

Gets or initializes unlock rarity, from zero through one hundred.

UnlockedIconUrl

public string? UnlockedIconUrl { get; init; }

Gets or initializes unlocked artwork.

WebUri

public Uri? WebUri { get; init; }

Gets or initializes an achievement web page.