14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
EmulatorSettingKeys14.1 Beta
public static class Unbroken.LaunchBox.Plugins.Emulators.EmulatorSettingKeysThe Unbroken.LaunchBox.Plugins.Forms.PluginFormField.Id values LaunchBox itself recognizes on a plugin's Unbroken.LaunchBox.Plugins.Forms.PluginConfigurationForm.
Remarks
A key listed here is an opt in: declare a setting with it and LaunchBox applies the matching built in behavior when the user turns it on. Every other key is private to the plugin that declared it. These are PERSISTED IDENTIFIERS, so they are plain string literals and will not change once shipped.Fields
public const string BorderlessFullscreen = "BorderlessFullscreen"public const string SettingsEnabled = "SettingsEnabled"
BorderlessFullscreen 14.1 Beta
public const string BorderlessFullscreen = "BorderlessFullscreen"Declare an Unbroken.LaunchBox.Plugins.Forms.PluginFormField.Boolean(System.String,Unbroken.LaunchBox.Plugins.PluginText,System.Boolean,Unbroken.LaunchBox.Plugins.PluginText) with this key to opt an emulator into LaunchBox's borderless fullscreen window handling.
Remarks
While it is on, LaunchBox finds the emulator's windows after launch, strips their caption and border, and stretches each one to exactly fill the monitor it is already on, so the emulator looks fullscreen without being an always on top fullscreen window. That is what lets the LaunchBox pause and startup screens appear in front of the running game. LaunchBox only manages the windows; the plugin remains responsible for launching the emulator in windowed mode from its Unbroken.LaunchBox.Plugins.Emulators.IEmulatorLaunchPreparer.PrepareEmulatorForLaunch(Unbroken.LaunchBox.Plugins.Emulators.EmulatorLaunchPreparationRequest) implementation. An emulator left in its own native fullscreen mode gets no benefit from this setting. LaunchBox applies the treatment shortly after launch and re-checks it a small number of times while the emulator settles. It is not enforced for the lifetime of the game, so an emulator that later restores its own window style keeps it.SettingsEnabled 14.1 Beta
public const string SettingsEnabled = "SettingsEnabled"The reserved field identifier for LaunchBox's master opt in switch.