LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IGameBadge10.11

C#
public interface Unbroken.LaunchBox.Plugins.Data.IGameBadge
Represents a badge that can be displayed on games; can be implemented as a plugin and will be automatically added to LaunchBox

Properties

DefaultIcon 10.11

C#
System.Drawing.Image DefaultIcon { get; }
The default image icon to display for the badge; can be overridden by the user in the file system

Index 10.11

C#
int Index { get; set; }
The index of where to display the badge in the list

Name 10.11

C#
string Name { get; }
The user-friendly (and hopefully translated) name of the badge (displays with a tooltip)

UniqueId 10.11

C#
string UniqueId { get; }
The unique ID/never-changing name of the badge; used for XML settings saving and image file lookups

Methods

GetAppliesToGame 10.11

C#
bool GetAppliesToGame(Unbroken.LaunchBox.Plugins.Data.IGame game)
Gets a value specifying whether or not this badge applies to the specified game
game 10.11
The game to check

Returns

A boolean value specifying whether or not this badge applies to the game specified