LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IRetroAchievementsApi8.0

C#
public interface Unbroken.LaunchBox.Plugins.RetroAchievements.IRetroAchievementsApi
This interface provides access to the retroachievements.org API. Use the PluginHelper's static Unbroken.LaunchBox.Plugins.PluginHelper.RetroAchievementsApi property to access the instance methods of the API.

Methods

GetAllUserCompletionProgress 13.15

C#
System.Collections.Generic.List<Unbroken.LaunchBox.Plugins.RetroAchievements.GameCompletionProgress>? GetAllUserCompletionProgress()
Gets a list of all games the user has any achievement progress for

Returns

Returns null if the user has no credentials entered, otherwise returns a list of games the user has any achievement progress on

GetConsoles 8.0

C#
System.Collections.Generic.IEnumerable<Unbroken.LaunchBox.Plugins.RetroAchievements.Console>? GetConsoles()
Gets an enumeration of all consoles that are available from retroachievements.org.

Returns

An enumeration of Console objects that represent the consoles available. May be null if credentials have not been configured.

GetGameInfo 8.0

C#
Unbroken.LaunchBox.Plugins.RetroAchievements.GameInfo? GetGameInfo(string gameId)
Gets game information for the specified retroachievements.org game ID.
gameId 8.0
The retroachievements.org game ID to retrieve information for.

Returns

A GameInfo object with all relevant information. May be null if credentials have not been configured.

GetGameInfoWithProgress 8.0

C#
Unbroken.LaunchBox.Plugins.RetroAchievements.GameInfoWithProgress? GetGameInfoWithProgress(string gameId)
Gets game and related user progress information for the specified retroachievements.org game ID.
gameId 8.0
The retroachievements.org game ID to retrieve information for.

Returns

A GameInfoWithProgress object with all relevant information. May be null if credentials have not been configured.

GetGameInfoWithProgress 8.0

C#
Unbroken.LaunchBox.Plugins.RetroAchievements.GameInfoWithProgress? GetGameInfoWithProgress(Unbroken.LaunchBox.Plugins.Data.IGame game)
Gets game and related user progress information for the specified game.
game 8.0
The IGame to retrieve information for.

Returns

A GameInfoWithProgress object with all relevant information. May be null if credentials have not been configured or the game is not found.

GetGameProgression 13.27

C#
Unbroken.LaunchBox.Plugins.RetroAchievements.GameInfoWithProgress? GetGameProgression(string gameId)
Retrieves aggregate achievement-progression and completion-time statistics for a game.
gameId 13.27
The RetroAchievements game identifier.

Returns

The available progression data, or null if unsupported or unavailable. The default implementation returns null.

GetGameProgression 13.27

C#
Unbroken.LaunchBox.Plugins.RetroAchievements.GameInfoWithProgress? GetGameProgression(Unbroken.LaunchBox.Plugins.Data.IGame game)
Retrieves aggregate achievement-progression and completion-time statistics for a game.
game 13.27
The library game whose RetroAchievements identity should be resolved.

Returns

The available progression data, or null if unsupported or unavailable. The default implementation returns null.

GetGamesForConsole 8.0

C#
System.Collections.Generic.IEnumerable<Unbroken.LaunchBox.Plugins.RetroAchievements.Game>? GetGamesForConsole(string consoleId)
Gets an enumeration of all games with achievements that are available for the specified console ID.
consoleId 8.0
The retroachievements.org console ID to retrieve the list of games for.

Returns

An enumeration of Game objects that represent the games available for the specified console ID. May be null if credentials have not been configured.

GetHasCredentials 8.0

C#
bool GetHasCredentials()
Gets a Boolean value specifying whether or not LaunchBox has been configured with credentials for retroachievements.org. Does not guarantee working credentials.

Returns

A boolean value specifying whether or not credentials have been entered by the user for retroachievements.org. Does not guarantee that they are valid credentials.

GetRecentlyPlayedGames 8.0

C#
System.Collections.Generic.IEnumerable<Unbroken.LaunchBox.Plugins.RetroAchievements.RecentlyPlayedGame>? GetRecentlyPlayedGames(int count, int offset)
Gets an enumeration of games that have been recently played by the user.
count 8.0
The number of games to retrieve.
offset 8.0
The number of games to skip (for paging).

Returns

An enumeration of RecentlyPlayedGame objects that represent the recently played games. May be null if credentials have not been configured.

GetUserRankAndScore 8.0

C#
Unbroken.LaunchBox.Plugins.RetroAchievements.UserRankAndScore? GetUserRankAndScore()
Gets the current user's rank and score.

Returns

A UserRankAndScore object with all relevant information. May be null if credentials have not been configured.

GetUserSummary 10.8

C#
Unbroken.LaunchBox.Plugins.RetroAchievements.UserSummary? GetUserSummary(int recentGamesCount, int recentAchievementCount)
Gets the users summary from retroachievements.org.
recentGamesCount 10.8
The last number of games recently played.
recentAchievementCount 10.8
The last number of achievements earned.

Returns

The user's summary, or null when credentials are missing or the summary could not be retrieved.