14.1 Beta 1 SDK

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

IEmulator7.10

public interface Unbroken.LaunchBox.Plugins.Data.IEmulator

This interface represents an Emulator that is used in LaunchBox/Big Box.

Properties

bool AggressiveWindowHiding { get; set; }
string ApplicationPath { get; set; }
bool AutoExtract { get; set; }
string AutoHotkeyScript { get; set; }
string CommandLine { get; set; }
string DefaultPlatform { get; set; }
bool DisableShutdownScreen { get; set; }
bool EnableHardcoreAchievements { get; set; }
string ExitAutoHotkeyScript { get; set; }
bool FileNameWithoutExtensionAndPath { get; set; }
bool ForceFrontendFocusOnShutdown { get; set; }
bool HideAllNonExclusiveFullscreenWindows { get; set; }
bool HideConsole { get; set; }
bool HideMouseCursorInGame { get; set; }
string Id { get; }
string LoadStateAutoHotkeyScript { get; set; }
bool MonitorStartupShutdownWithProcess { get; set; }
bool NoQuotes { get; set; }
bool NoSpace { get; set; }
string PauseAutoHotkeyScript { get; set; }
string ResetAutoHotkeyScript { get; set; }
string ResumeAutoHotkeyScript { get; set; }
string SaveStateAutoHotkeyScript { get; set; }
int StartupLoadDelay { get; set; }
int StartupScreenPostLaunchDisplayTime { get; set; }
string SwapDiscsAutoHotkeyScript { get; set; }
string Title { get; set; }
bool UseStartupScreen { get; set; }

AggressiveWindowHiding 9.4

bool AggressiveWindowHiding { get; set; }

Gets or sets a value specifying whether or not to use aggressive strategies for hiding startup windows, which could be problematic for some emulators. Added in LaunchBox and Big Box 9.2.

ApplicationPath 7.10

string ApplicationPath { get; set; }

Gets or sets the Application Path to use when launching the Emulator.

AutoExtract 7.10

bool AutoExtract { get; set; }

Gets or sets a value specifying whether or not to extract ROM archives before launching the Emulator.

AutoHotkeyScript 7.10

string AutoHotkeyScript { get; set; }

Gets or sets the AutoHotkey Script to use when launching the Emulator.

CommandLine 7.10

string CommandLine { get; set; }

Gets or sets the command line parameters to use when launching the Emulator.

DefaultPlatform 7.10

string DefaultPlatform { get; set; }

Gets or sets the default platform for the Emulator.

DisableShutdownScreen 9.4

bool DisableShutdownScreen { get; set; }

Gets or sets a value specifying whether or not to disable the shutdown screen for this Emulator. Added in LaunchBox and Big Box 9.2.

EnableHardcoreAchievements 13.22

bool EnableHardcoreAchievements { get; set; }

Should hardcore achievements be enabled for this emulator

ExitAutoHotkeyScript 13.15

string ExitAutoHotkeyScript { get; set; }

Gets or sets the AutoHotKey Script that closes the emulator

FileNameWithoutExtensionAndPath 7.10

bool FileNameWithoutExtensionAndPath { get; set; }

Gets or sets a value specifying whether or not to use the ROM file name without the extension and path when launching the Emulator.

ForceFrontendFocusOnShutdown 14.0

bool ForceFrontendFocusOnShutdown { get; set; }

Gets or sets whether LaunchBox or Big Box should attempt to reclaim focus after the shutdown screen closes.

HideAllNonExclusiveFullscreenWindows 9.2

bool HideAllNonExclusiveFullscreenWindows { get; set; }

Gets or sets a value specifying whether or not to hide all non-exclusive fullscreen windows when using the LaunchBox startup screen for this Emulator. Added in LaunchBox and Big Box 9.2-beta-3.

HideConsole 7.10

bool HideConsole { get; set; }

Gets or sets a value specifying whether or not to attempt to hide the console when launching the Emulator.

HideMouseCursorInGame 9.2

bool HideMouseCursorInGame { get; set; }

Gets or sets a value specifying whether or not to hide the mouse cursor in-game when using the LaunchBox startup screen for this Emulator. Added in LaunchBox and Big Box 9.2-beta-3.

Id 7.10

string Id { get; }

Gets or the ID of the Emulator. The ID is automatically assigned when creating a new Emulator.

LoadStateAutoHotkeyScript 13.15

string LoadStateAutoHotkeyScript { get; set; }

Gets or sets the AutoHotKey Script that causes the emulator to save it's current save state slot.

MonitorStartupShutdownWithProcess 14.0

bool MonitorStartupShutdownWithProcess { get; set; }

Gets or sets whether the startup and shutdown screens should automatically hide when the game or emulator process is detected.

NoQuotes 7.10

bool NoQuotes { get; set; }

Gets or sets a value specifying whether or not quotes should be used when sending the ROM file name to the Emulator.

NoSpace 7.10

bool NoSpace { get; set; }

Gets or sets a value specifying whether or not to add a space before the the ROM file name when launching the Emulator.

PauseAutoHotkeyScript 13.15

string PauseAutoHotkeyScript { get; set; }

Gets or sets the AutoHotKey Script to use when opening the pause screen.

ResetAutoHotkeyScript 13.15

string ResetAutoHotkeyScript { get; set; }

Gets or sets the AutoHotKey Script that causes the emulator to restart the ROM being played.

ResumeAutoHotkeyScript 13.15

string ResumeAutoHotkeyScript { get; set; }

Gets or sets the AutoHotKey Script to use when closing the pause screen.

SaveStateAutoHotkeyScript 13.15

string SaveStateAutoHotkeyScript { get; set; }

Gets or sets the AutoHotKey Script that causes the emulator to save it's current save state slot.

StartupLoadDelay 9.2

int StartupLoadDelay { get; set; }

Gets or sets a value specifying the startup delay in milliseconds when using the LaunchBox startup screen for this Emulator. Added in LaunchBox and Big Box 9.2-beta-3.

StartupScreenPostLaunchDisplayTime 14.0

int StartupScreenPostLaunchDisplayTime { get; set; }

Gets or sets the amount of time, in milliseconds, to keep the startup screen visible after the game or emulator window is detected. Added in LaunchBox and Big Box 13.28.

SwapDiscsAutoHotkeyScript 13.15

string SwapDiscsAutoHotkeyScript { get; set; }

Gets or sets the AutoHotKey Script that causes the emulator to change discs.

Title 7.10

string Title { get; set; }

Gets or sets the Title of the Emulator.

UseStartupScreen 9.2

bool UseStartupScreen { get; set; }

Gets or sets a value specifying whether or not to use the LaunchBox startup screen for this Emulator. Added in LaunchBox and Big Box 9.2-beta-3.

Methods

Unbroken.LaunchBox.Plugins.Data.IEmulatorPlatform AddNewEmulatorPlatform()
Unbroken.LaunchBox.Plugins.Data.IEmulatorPlatform[] GetAllEmulatorPlatforms()
bool TryRemoveEmulatorPlatform(Unbroken.LaunchBox.Plugins.Data.IEmulatorPlatform emulatorPlatform)

AddNewEmulatorPlatform 7.10

Unbroken.LaunchBox.Plugins.Data.IEmulatorPlatform AddNewEmulatorPlatform()

Adds a new Emulator Platform to this Emulator.

Returns

The new Emulator Platform.

GetAllEmulatorPlatforms 7.10

Unbroken.LaunchBox.Plugins.Data.IEmulatorPlatform[] GetAllEmulatorPlatforms()

Gets all of the platforms associated with this Emulator.

Returns

An array of Emulator Platforms associated with this Emulator.

TryRemoveEmulatorPlatform 7.10

bool TryRemoveEmulatorPlatform(Unbroken.LaunchBox.Plugins.Data.IEmulatorPlatform emulatorPlatform)

Attempts to remove an Emulator Platform from this Emulator.

emulatorPlatform 7.10: The Emulator Platform to remove.

Returns

A value specifying whether or not the Emulator Platform was successfully removed. If this method returns false, most likely the Emulator Platform was not found on the Emulator.