IEmulator7.10
Interface in Unbroken.LaunchBox.Plugins.Data
public interface IEmulator
This interface represents an Emulator that is used in LaunchBox/Big Box.
Properties
AggressiveWindowHiding9.4Gets 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.ApplicationPathGets or sets the Application Path to use when launching the Emulator.AutoExtractGets or sets a value specifying whether or not to extract ROM archives before launching the Emulator.AutoHotkeyScriptGets or sets the AutoHotkey Script to use when launching the Emulator.CommandLineGets or sets the command line parameters to use when launching the Emulator.DefaultPlatformGets or sets the default platform for the Emulator.DisableShutdownScreen9.4Gets or sets a value specifying whether or not to disable the shutdown screen for this Emulator. Added in LaunchBox and Big Box 9.2.EnableHardcoreAchievements13.22Should hardcore achievements be enabled for this emulatorExitAutoHotkeyScript13.15Gets or sets the AutoHotKey Script that closes the emulatorFileNameWithoutExtensionAndPathGets or sets a value specifying whether or not to use the ROM file name without the extension and path when launching the Emulator.ForceFrontendFocusOnShutdown14.0Gets or sets whether LaunchBox or Big Box should attempt to reclaim focus after the shutdown screen closes.HideAllNonExclusiveFullscreenWindows9.2Gets 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.HideConsoleGets or sets a value specifying whether or not to attempt to hide the console when launching the Emulator.HideMouseCursorInGame9.2Gets 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.IdGets or the ID of the Emulator. The ID is automatically assigned when creating a new Emulator.LoadStateAutoHotkeyScript13.15Gets or sets the AutoHotKey Script that causes the emulator to save it's current save state slot.MonitorStartupShutdownWithProcess14.0Gets or sets whether the startup and shutdown screens should automatically hide when the game or emulator process is detected.NoQuotesGets or sets a value specifying whether or not quotes should be used when sending the ROM file name to the Emulator.NoSpaceGets or sets a value specifying whether or not to add a space before the the ROM file name when launching the Emulator.PauseAutoHotkeyScript13.15Gets or sets the AutoHotKey Script to use when opening the pause screen.ResetAutoHotkeyScript13.15Gets or sets the AutoHotKey Script that causes the emulator to restart the ROM being played.ResumeAutoHotkeyScript13.15Gets or sets the AutoHotKey Script to use when closing the pause screen.SaveStateAutoHotkeyScript13.15Gets or sets the AutoHotKey Script that causes the emulator to save it's current save state slot.StartupLoadDelay9.2Gets 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.StartupScreenPostLaunchDisplayTime14.0Gets 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.SwapDiscsAutoHotkeyScript13.15Gets or sets the AutoHotKey Script that causes the emulator to change discs.TitleGets or sets the Title of the Emulator.UseStartupScreen9.2Gets 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.
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
string ApplicationPath { get; set; }
Gets or sets the Application Path to use when launching the Emulator.
AutoExtract
bool AutoExtract { get; set; }
Gets or sets a value specifying whether or not to extract ROM archives before launching the Emulator.
AutoHotkeyScript
string AutoHotkeyScript { get; set; }
Gets or sets the AutoHotkey Script to use when launching the Emulator.
CommandLine
string CommandLine { get; set; }
Gets or sets the command line parameters to use when launching the Emulator.
DefaultPlatform
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
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
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
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
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
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
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
AddNewEmulatorPlatformAdds a new Emulator Platform to this Emulator.GetAllEmulatorPlatformsGets all of the platforms associated with this Emulator.TryRemoveEmulatorPlatformAttempts to remove an Emulator Platform from this Emulator.
AddNewEmulatorPlatform
IEmulatorPlatform AddNewEmulatorPlatform()
Adds a new Emulator Platform to this Emulator.
Returns
The new Emulator Platform.GetAllEmulatorPlatforms
IEmulatorPlatform[] GetAllEmulatorPlatforms()
Gets all of the platforms associated with this Emulator.
Returns
An array of Emulator Platforms associated with this Emulator.TryRemoveEmulatorPlatform
bool TryRemoveEmulatorPlatform(IEmulatorPlatform emulatorPlatform)
Attempts to remove an Emulator Platform from this Emulator.
emulatorPlatform- The Emulator Platform to remove.