RetroHubSystemData

Represents a system from the user’s library. Holds all informations available about a system. It is generated by RetroHub when the app in launched, and passed to themes through the system_received signal.

The received object is unique and shared among the app. An instance can also be used to uniquely identify this system, which is done for other parts of the API.

Enumerations

enum Category:

• Console - A retro console.

• Arcade - An arcade machine.

• Computer - A retro computer.

• GameEngine - A game engine.

• ModernConsole - A modern console (7th generation upwards).

Properties

Type	Name	Default
String	name	other
String	fullname	""
String	platform	""
Category	category	0
int	num_games	""

---

String name = "..."

The system’s “short” name. This field is always set, and uniquely identifies this system.

---

String fullname = ""

The system’s full name.

---

String platform = ""

The system’s platform. While usually the same as the name field, it can be different for systems that are very similar to a base system, such that RetroHub uses the same configuration among them. For example, Nintendo 64 DD on Nintendo 64 and Sega Genesis CD on Sega Genesis.

---

Category category = 0

The system’s category.

---

int num_games = 0

The number of games detected for this system. In practice, this will always be larger than 0, as RetroHub doesn’t send system data if there are no games for it. This can be used to known in advance how many game datas will arrive for that specific system.

Methods

Type	Name
Category	category_to_idx
String	idx_to_category

---

Category category_to_idx ( String category )

Converts a category name to the enum value. Used internally.

---

String idx_to_category ( Category category )

Converts a category enum value to a string name. Used internally.