RetroAchievements.GameInfo

This class contains all information about a game’s achievements.

Note

For a proper guide on how to use this integration, please refer to the dedicated integration guide.

Enumerations

enum Error:

  • OK - Success / no error.

  • ERR_INVALID_CRED - The user’s credentials are invalid.

  • ERR_CONSOLE_NOT_SUPPORTED - The requested game’s system is not supported by RetroAchievements.

  • ERR_GAME_NOT_FOUND - The requested game hash was not found on RetroAchievements.

  • ERR_NETWORK - A network error occurred.

  • ERR_INTERNAL - An internal error occurred.

Properties

Type

Name

Default

GameInfo.Error

err

OK

int

id

0

Array [ RetroAchievements.Achievement ]

achievements

[]

int

player_count

0


GameInfo.Error err = OK

The error code of the function call that generated/returned this game info. If not OK, the remaining properties will have no meaning, and this object should be discarded.


int id = 0

The game’s ID on RetroAchievements.


Array [ RetroAchievements.Achievement ] achievements = []

An Array of RetroAchievements.Achievement objects, containing all the achievements available for this game.


int player_count = 0

The total number of players that have played this game on RetroAchievements.

Methods

Type

Name

void

parse_raw


void parse_raw (Dictionary data)

Parses a raw JSON response from RetroAchievements’s API into this object. Used internally by RetroHub.