LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

GameInfoWithProgress8.0

C#
public class Unbroken.LaunchBox.Plugins.RetroAchievements.GameInfoWithProgress
Contains RetroAchievements game metadata, user progress, or aggregate completion-time statistics.

Remarks

Response fields may be absent. String-valued identifiers, counts, flags, and dates retain the API representation and must be parsed before numeric or date calculations.

Constructors

GameInfoWithProgress 8.0

C#
public GameInfoWithProgress()

A summary has not been written for this member.

Fields

Achievements 8.0

C#
public System.Collections.Generic.Dictionary<string, Unbroken.LaunchBox.Plugins.RetroAchievements.Achievement>? Achievements
The achievement records keyed by RetroAchievements achievement identifier.

ConsoleID 8.0

C#
public string? ConsoleID
The RetroAchievements console identifier.

ConsoleName 8.0

C#
public string? ConsoleName
The console display name.

Developer 8.0

C#
public string? Developer
The game developer metadata.

Flags 8.0

C#
public string? Flags
The service-defined game flags.

ForumTopicID 8.0

C#
public string? ForumTopicID
The identifier of the game's discussion topic.

Genre 8.0

C#
public string? Genre
The game genre metadata.

HighestAwardKind 13.22

C#
public string? HighestAwardKind
The highest game award reported for the user, such as mastered or beaten-hardcore.

ID 8.0

C#
public string? ID
The RetroAchievements game identifier.

ImageBoxArt 8.0

C#
public string? ImageBoxArt
The box-art image path relative to the RetroAchievements site.

ImageIcon 8.0

C#
public string? ImageIcon
The game icon path relative to the RetroAchievements site.

ImageIngame 8.0

C#
public string? ImageIngame
The gameplay image path relative to the RetroAchievements site.

ImageTitle 8.0

C#
public string? ImageTitle
The title-screen image path relative to the RetroAchievements site.

IsFinal 8.0

C#
public string? IsFinal
The legacy game-finalization flag retained from the response.

MedianTimeToBeatHardcore 13.27

C#
public string? MedianTimeToBeatHardcore
The median time to beat the game in hardcore mode, in seconds.

MedianTimeToMaster 13.27

C#
public string? MedianTimeToMaster
The median time to earn all core achievements in hardcore mode, in seconds.

NumAchievements 8.0

C#
public string? NumAchievements
The number of core achievements for the game.

NumAwardedToUser 8.0

C#
public string? NumAwardedToUser
The number of achievements earned by the user for this game.

NumAwardedToUserHardcore 8.0

C#
public string? NumAwardedToUserHardcore
The number of achievements the user earned in hardcore mode for this game.

NumDistinctPlayersCasual 8.0

C#
public string? NumDistinctPlayersCasual
The player count returned under the legacy casual-player field.

NumDistinctPlayersHardcore 8.0

C#
public string? NumDistinctPlayersHardcore
The player count returned under the legacy hardcore-player field.

Publisher 8.0

C#
public string? Publisher
The game publisher metadata.

Released 8.0

C#
public string? Released
The release date text supplied by RetroAchievements.

RichPresencePatch 8.0

C#
public string? RichPresencePatch
The rich-presence script identifier returned by the service.

TimesUsedInHardcoreBeatMedian 13.27

C#
public string? TimesUsedInHardcoreBeatMedian
The number of samples used for the hardcore beaten-time median.

TimesUsedInMasteryMedian 13.27

C#
public string? TimesUsedInMasteryMedian
The number of samples used for the mastery-time median.

Title 8.0

C#
public string? Title
The game title.

UserCompletion 8.0

C#
public string? UserCompletion
The user's achievement completion percentage as formatted by the service.

UserCompletionHardcore 8.0

C#
public string? UserCompletionHardcore
The user's hardcore completion percentage as formatted by the service.