LaunchBoxContributors
On this page

IAdditionalApplication7.10

Interface in Unbroken.LaunchBox.Plugins.Data

C#
public interface IAdditionalApplication
This interface represents an Additional Application that is associated with an IGame in LaunchBox/Big Box.

Properties

  • ApplicationPathGets or sets the application path associated with this Additional Application.
  • AutoRunAfterGets or sets a value specifying whether or not to automatically run this Additional Application after running the main game.
  • AutoRunBeforeGets or sets a value specifying whether or not to automatically run this Additional Application before running the main game.
  • CommandLineGets or sets the command line parameters used when launching this Additional Application.
  • DeveloperGets or sets a value specifying the Developer of the Additional Application.
  • DiscGets or sets a value specifying the disc number of the Additional Application.
  • EmulatorIdGets or sets a value specifying the ID of the emulator used for the Additional Application. Maps up directly to the emulator's IEmulator.Id property.
  • GameIdGets the ID of the game that is associated with this Additional Application. Maps up directly to the game's IGame.Id property.
  • IdGets the ID of the Additional Application. This ID is automatically generated when a new Additional Application is created.
  • Installed10.11Gets or sets a value specifying the installation state of this Addition Application.
  • LastPlayedGets or sets a value specifying when the Additional Application was last played.
  • NameGets or sets the Name of this Additional Application.
  • PlayCountGets or sets the number of times this Additional Application has been played.
  • PlayTime12.5Gets or sets the amount of time this Additional Application has been played (in seconds).
  • PriorityGets or sets a value specifying the Priority of this Additional Application. Priority is used for sorting additional applications.
  • PublisherGets or sets a value specifying the Publisher of the Additional Application.
  • RegionGets or sets a value specifying the Region of the Additional Application.
  • ReleaseDateGets or sets a value specifying the Release Date of the Additional Application.
  • SideAGets or sets a value specifying whether this Additional Application represents Side A or not.
  • SideBGets or sets a value specifying whether this Additional Application represents Side B or not.
  • StatusGets or sets a value specifying the Status of the Additional Application.
  • UseDosBoxGets or sets a value specifying whether this Additional Application should use DOSBox or not when launching.
  • UseEmulatorGets or sets a value specifying whether this Additional Application should use an emulator or not when launching.
  • VersionGets or sets a value specifying the Version of the Additional Application.
  • WaitForExitGets or sets a value specifying whether this Additional Application should wait for exit before launching the game.

ApplicationPath

C#
string ApplicationPath { get; set; }
Gets or sets the application path associated with this Additional Application.

AutoRunAfter

C#
bool AutoRunAfter { get; set; }
Gets or sets a value specifying whether or not to automatically run this Additional Application after running the main game.

AutoRunBefore

C#
bool AutoRunBefore { get; set; }
Gets or sets a value specifying whether or not to automatically run this Additional Application before running the main game.

CommandLine

C#
string CommandLine { get; set; }
Gets or sets the command line parameters used when launching this Additional Application.

Developer

C#
string Developer { get; set; }
Gets or sets a value specifying the Developer of the Additional Application.

Disc

C#
int? Disc { get; set; }
Gets or sets a value specifying the disc number of the Additional Application.

EmulatorId

C#
string EmulatorId { get; set; }
Gets or sets a value specifying the ID of the emulator used for the Additional Application. Maps up directly to the emulator's IEmulator.Id property.

GameId

C#
string GameId { get; }
Gets the ID of the game that is associated with this Additional Application. Maps up directly to the game's IGame.Id property.

Id

C#
string Id { get; }
Gets the ID of the Additional Application. This ID is automatically generated when a new Additional Application is created.

Installed 10.11

C#
bool? Installed { get; set; }
Gets or sets a value specifying the installation state of this Addition Application.

LastPlayed

C#
DateTime? LastPlayed { get; set; }
Gets or sets a value specifying when the Additional Application was last played.

Name

C#
string Name { get; set; }
Gets or sets the Name of this Additional Application.

PlayCount

C#
int PlayCount { get; set; }
Gets or sets the number of times this Additional Application has been played.

PlayTime 12.5

C#
int PlayTime { get; set; }
Gets or sets the amount of time this Additional Application has been played (in seconds).

Priority

C#
int Priority { get; set; }
Gets or sets a value specifying the Priority of this Additional Application. Priority is used for sorting additional applications.

Publisher

C#
string Publisher { get; set; }
Gets or sets a value specifying the Publisher of the Additional Application.

Region

C#
string Region { get; set; }
Gets or sets a value specifying the Region of the Additional Application.

ReleaseDate

C#
DateTime? ReleaseDate { get; set; }
Gets or sets a value specifying the Release Date of the Additional Application.

SideA

C#
bool SideA { get; set; }
Gets or sets a value specifying whether this Additional Application represents Side A or not.

SideB

C#
bool SideB { get; set; }
Gets or sets a value specifying whether this Additional Application represents Side B or not.

Status

C#
string Status { get; set; }
Gets or sets a value specifying the Status of the Additional Application.

UseDosBox

C#
bool UseDosBox { get; set; }
Gets or sets a value specifying whether this Additional Application should use DOSBox or not when launching.

UseEmulator

C#
bool UseEmulator { get; set; }
Gets or sets a value specifying whether this Additional Application should use an emulator or not when launching.

Version

C#
string Version { get; set; }
Gets or sets a value specifying the Version of the Additional Application.

WaitForExit

C#
bool WaitForExit { get; set; }
Gets or sets a value specifying whether this Additional Application should wait for exit before launching the game.

Methods

  • GetEffectiveCommandLine13.16This will get the command line that is used when this app is launched. This is different than the standard CommandLine property in that this will grab the command line from the appropriate emulator as well if the app doesn't override it.
  • GetIconImageGets the image that should be used as an icon when displaying the Additional Application.
  • LaunchLaunches the Additional Application.

GetEffectiveCommandLine 13.16

C#
string GetEffectiveCommandLine()
This will get the command line that is used when this app is launched. This is different than the standard CommandLine property in that this will grab the command line from the appropriate emulator as well if the app doesn't override it.

Returns

The command line sent to the process that starts the app

GetIconImage

C#
Image GetIconImage(IGame game)
Gets the image that should be used as an icon when displaying the Additional Application.
game
The game that is associated with the Additional Application. Used to determine the correct image.

Returns

The image to use for the icon.

Launch

C#
string Launch(IGame game)
Launches the Additional Application.
game
The game that is associated with the Additional Application. Used in order to launch the Additional Application correctly.

Returns

A value specifying whether the Additional Application was successfully launched. If launched successfully, NULL will be returned. Otherwise, an error message will be returned that can be shown to the user.