LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

AchievementDefinition14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Achievements.AchievementDefinition
Defines one achievement independently of account progress.

Constructors

AchievementDefinition 14.1 Beta

C#
public AchievementDefinition(string achievementId, string name)
Creates an achievement definition.
achievementId 14.1 Beta
Opaque source-local achievement ID.
name 14.1 Beta
Provider-returned achievement title.

Properties

AchievementId 14.1 Beta

C#
public string AchievementId { get; }
Gets the source-local achievement ID.

Description 14.1 Beta

C#
public string? Description { get; init; }
Gets or initializes the description.

DisplayOrder 14.1 Beta

C#
public int DisplayOrder { get; init; }
Gets or initializes provider display ordering.

IsHidden 14.1 Beta

C#
public bool IsHidden { get; init; }
Gets or initializes whether locked details should be concealed.

Kind 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Achievements.AchievementKind Kind { get; init; }
Gets or initializes list classification.

LockedIconUrl 14.1 Beta

C#
public string? LockedIconUrl { get; init; }
Gets or initializes locked artwork.

Name 14.1 Beta

C#
public string Name { get; }
Gets the returned title.

Points 14.1 Beta

C#
public int? Points { get; init; }
Gets or initializes the optional points value.

RarityPercent 14.1 Beta

C#
public double? RarityPercent { get; init; }
Gets or initializes unlock rarity, from zero through one hundred.

UnlockedIconUrl 14.1 Beta

C#
public string? UnlockedIconUrl { get; init; }
Gets or initializes unlocked artwork.

WebUri 14.1 Beta

C#
public System.Uri? WebUri { get; init; }
Gets or initializes an achievement web page.