LaunchBoxContributors
On this page

PluginHelper7.10

Class in Unbroken.LaunchBox.Plugins

C#
public static class PluginHelper
Used to provide logic, state information, and data to LaunchBox and Big Box plugins.

Properties

  • BigBoxMainViewModelChanged 13.27Gets or sets the Big Box main view model that is used to navigate around in Big Box. Will be null when in LaunchBox. This property is automatically set by Big Box and should not be set by any plugins.
  • DataManagerGets or sets the Data Manager object used to access all data in LaunchBox and Big Box. This property is automatically set by LaunchBox and Big Box and should not be set by any plugins.
  • LaunchBoxMainViewModel9.2Gets or sets the LaunchBox main view model that is used to navigate around in LaunchBox. Will be null when in Big Box. This property is automatically set by LaunchBox and should not be set by any plugins. Added in LaunchBox and Big Box 9.2-beta-3.
  • RetroAchievementsApi8.0Gets or sets the Retro Achievements API. This property is automatically set by LaunchBox and Big Box and should not be set by any plugins.
  • StateManagerGets or sets the State Manager object used to access current state information for LaunchBox and Big Box. This property is automatically set by LaunchBox and Big Box and should not be set by any plugins.

BigBoxMainViewModel Changed 13.27

C#
public static IBigBoxMainViewModel? BigBoxMainViewModel { get; set; }
Gets or sets the Big Box main view model that is used to navigate around in Big Box. Will be null when in LaunchBox. This property is automatically set by Big Box and should not be set by any plugins.

DataManager

C#
public static IDataManager DataManager { get; set; }
Gets or sets the Data Manager object used to access all data in LaunchBox and Big Box. This property is automatically set by LaunchBox and Big Box and should not be set by any plugins.

LaunchBoxMainViewModel 9.2

C#
public static ILaunchBoxMainViewModel? LaunchBoxMainViewModel { get; set; }
Gets or sets the LaunchBox main view model that is used to navigate around in LaunchBox. Will be null when in Big Box. This property is automatically set by LaunchBox and should not be set by any plugins. Added in LaunchBox and Big Box 9.2-beta-3.

RetroAchievementsApi 8.0

Obsolete since 14.1

Request Services.Achievements.IAchievementManager through constructor injection for provider-neutral achievement data.

C#
public static IRetroAchievementsApi RetroAchievementsApi { get; set; }
Gets or sets the Retro Achievements API. This property is automatically set by LaunchBox and Big Box and should not be set by any plugins.

StateManager

C#
public static IStateManager StateManager { get; set; }
Gets or sets the State Manager object used to access current state information for LaunchBox and Big Box. This property is automatically set by LaunchBox and Big Box and should not be set by any plugins.