14.1 Beta 1 SDK
IGame7.10
public interface Unbroken.LaunchBox.Plugins.Data.IGame
This interface represents a Game that is used in LaunchBox/Big Box.
Properties
bool AggressiveWindowHiding { get; set; }string ApplicationPath { get; set; }string BackgroundImagePath { get; }string BackImagePath { get; }string Box3DImagePath { get; }bool Broken { get; set; }string Cart3DImagePath { get; }string CartBackImagePath { get; }string CartFrontImagePath { get; }string ClearLogoImagePath { get; }string CloneOf { get; set; }string CommandLine { get; set; }float CommunityOrLocalStarRating { get; }float CommunityStarRating { get; set; }int CommunityStarRatingTotalVotes { get; set; }bool Completed { get; set; }string ConfigurationCommandLine { get; set; }string ConfigurationPath { get; set; }System.DateTime DateAdded { get; set; }System.DateTime DateModified { get; set; }string DetailsWithoutPlatform { get; }string DetailsWithPlatform { get; }string Developer { get; set; }string[] Developers { get; }bool DisableShutdownScreen { get; set; }string DosBoxConfigurationPath { get; set; }string EmulatorId { get; set; }bool Favorite { get; set; }string FrontImagePath { get; }System.Collections.Concurrent.BlockingCollection<string> Genres { get; }string GenresString { get; set; }bool Hide { get; set; }bool HideAllNonExclusiveFullscreenWindows { get; set; }bool HideMouseCursorInGame { get; set; }string Id { get; }bool? Installed { get; set; }System.DateTime? LastPlayedDate { get; set; }int? LaunchBoxDbId { get; set; }string ManualPath { get; set; }string MarqueeImagePath { get; }int? MaxPlayers { get; set; }bool MonitorStartupShutdownWithProcess { get; set; }string MusicPath { get; set; }string Notes { get; set; }bool OverrideDefaultStartupScreenSettings { get; set; }string Platform { get; set; }string PlatformClearLogoImagePath { get; }int PlayCount { get; set; }string PlayMode { get; set; }string[] PlayModes { get; }int PlayTime { get; set; }bool Portable { get; set; }string Progress { get; set; }string Publisher { get; set; }string[] Publishers { get; }string Rating { get; set; }System.Drawing.Image RatingImage { get; }string Region { get; set; }System.DateTime? ReleaseDate { get; set; }string ReleaseType { get; set; }int? ReleaseYear { get; set; }string RootFolder { get; set; }string ScreenshotImagePath { get; }bool ScummVmAspectCorrection { get; set; }bool ScummVmFullscreen { get; set; }string ScummVmGameDataFolderPath { get; set; }string ScummVmGameType { get; set; }string Series { get; set; }string[] SeriesValues { get; }bool ShowBack { get; set; }string SortTitle { get; set; }string SortTitleOrTitle { get; }string Source { get; set; }int StarRating { get; set; }float StarRatingFloat { get; set; }int StartupLoadDelay { get; set; }int StartupScreenPostLaunchDisplayTime { get; set; }string Status { get; set; }string ThemeVideoPath { get; set; }string Title { get; set; }bool UseDosBox { get; set; }bool UseScummVm { get; set; }bool UseStartupScreen { get; set; }string Version { get; set; }string VideoPath { get; set; }string VideoUrl { get; set; }int? WikipediaId { get; set; }string WikipediaUrl { get; set; }
AggressiveWindowHiding 9.4
bool AggressiveWindowHiding { get; set; }Gets or sets whether to use aggressive window hiding during startup.
ApplicationPath 7.10
string ApplicationPath { get; set; }Gets or sets the executable, game file, or launch URI used to start the game.
BackgroundImagePath 7.10
string BackgroundImagePath { get; }Gets the selected background image path.
BackImagePath 7.10
string BackImagePath { get; }Gets the selected back box image path.
Box3DImagePath 7.10
string Box3DImagePath { get; }Gets the selected three-dimensional box image path.
Broken 7.10
bool Broken { get; set; }Gets or sets whether the game is marked as broken.
Cart3DImagePath 7.10
string Cart3DImagePath { get; }Gets the selected three-dimensional cartridge image path.
CartBackImagePath 7.10
string CartBackImagePath { get; }Gets the selected cartridge back image path.
CartFrontImagePath 7.10
string CartFrontImagePath { get; }Gets the selected cartridge front image path.
ClearLogoImagePath 7.10
string ClearLogoImagePath { get; }Gets the selected clear-logo image path.
CloneOf 7.10
string CloneOf { get; set; }Gets or sets the parent game name used to identify an arcade clone.
CommandLine 7.10
string CommandLine { get; set; }Gets or sets the command-line arguments used when launching the game.
CommunityOrLocalStarRating 8.0
float CommunityOrLocalStarRating { get; }
Gets the star rating or community star rating depending on the user's community star rating settings and whether or not this game has a star rating set.
CommunityStarRating 8.0
float CommunityStarRating { get; set; }
Gets or sets the community star rating value.
CommunityStarRatingTotalVotes 8.0
int CommunityStarRatingTotalVotes { get; set; }
Gets or sets the number of community star rating votes.
Completed 7.10
Obsolete since 13.22
bool Completed { get; set; }
Obsolete. Please use Progress instead.
ConfigurationCommandLine 7.10
string ConfigurationCommandLine { get; set; }Gets or sets the command-line arguments for the game's configuration application.
ConfigurationPath 7.10
string ConfigurationPath { get; set; }Gets or sets the executable path or URI used to configure the game.
DateAdded 7.10
System.DateTime DateAdded { get; set; }Gets or sets the date and time the game was added to the library.
DateModified 7.10
System.DateTime DateModified { get; set; }Gets or sets the date and time the game record was last modified.
DetailsWithoutPlatform 7.10
string DetailsWithoutPlatform { get; }Gets the formatted game details without the platform.
DetailsWithPlatform 7.10
string DetailsWithPlatform { get; }Gets the formatted game details including the platform.
Developer 7.10
string Developer { get; set; }Gets or sets the developer metadata.
Developers 7.10
string[] Developers { get; }Gets the individual developers parsed from the developer metadata.
DisableShutdownScreen 9.4
bool DisableShutdownScreen { get; set; }Gets or sets whether to suppress the shutdown screen for this game.
DosBoxConfigurationPath 7.10
string DosBoxConfigurationPath { get; set; }Gets or sets the custom DOSBox configuration file path.
EmulatorId 7.10
string EmulatorId { get; set; }Gets or sets the identifier of the emulator assigned to the game.
Favorite 7.10
bool Favorite { get; set; }Gets or sets whether the game is marked as a favorite.
FrontImagePath 7.10
string FrontImagePath { get; }Gets the selected front box image path.
Genres 7.10
System.Collections.Concurrent.BlockingCollection<string> Genres { get; }Gets the game's genre collection.
GenresString 7.10
string GenresString { get; set; }Gets or sets the genres as a delimited string.
Hide 7.10
bool Hide { get; set; }Gets or sets whether the game is marked as hidden.
HideAllNonExclusiveFullscreenWindows 9.4
bool HideAllNonExclusiveFullscreenWindows { get; set; }Gets or sets whether startup handling hides windows that do not use exclusive fullscreen.
HideMouseCursorInGame 9.4
bool HideMouseCursorInGame { get; set; }Gets or sets whether to hide the mouse cursor while the game is running.
Id 7.10
string Id { get; }Gets the identifier of this library object.
Installed 10.11
bool? Installed { get; set; }Gets the effective installed state, or sets an explicit user override. Setting null clears the override; the getter returns null when the effective state is unknown.
LastPlayedDate 7.10
System.DateTime? LastPlayedDate { get; set; }Gets or sets the most recent play date, or null when unknown.
LaunchBoxDbId 7.10
int? LaunchBoxDbId { get; set; }Gets or sets the LaunchBox Games Database identifier, or null when not linked.
ManualPath 7.10
string ManualPath { get; set; }Gets or sets the configured game manual path.
MarqueeImagePath 7.10
string MarqueeImagePath { get; }Gets the selected arcade marquee image path.
MaxPlayers 11.3
int? MaxPlayers { get; set; }Gets or sets the maximum player count, or null when unknown.
MonitorStartupShutdownWithProcess 14.0
bool MonitorStartupShutdownWithProcess { get; set; }Gets or sets whether process lifetime determines startup and shutdown detection.
MusicPath 7.10
string MusicPath { get; set; }Gets or sets the configured game music path.
Notes 7.10
string Notes { get; set; }Gets or sets the descriptive notes, which may contain formatting.
OverrideDefaultStartupScreenSettings 9.4
bool OverrideDefaultStartupScreenSettings { get; set; }Gets or sets whether this game overrides the default startup-screen settings.
Platform 7.10
string Platform { get; set; }Gets or sets the associated platform name.
PlatformClearLogoImagePath 7.10
string PlatformClearLogoImagePath { get; }Gets the clear-logo image path for the game's platform.
PlayCount 7.10
int PlayCount { get; set; }Gets or sets the recorded number of launches.
PlayMode 7.10
string PlayMode { get; set; }Gets or sets the play-mode metadata.
PlayModes 7.10
string[] PlayModes { get; }Gets the individual play modes parsed from the play-mode metadata.
PlayTime 12.5
int PlayTime { get; set; }Gets or sets the recorded play time in seconds.
Portable 7.10
bool Portable { get; set; }Gets or sets whether the game is marked as portable.
Progress 13.22
string Progress { get; set; }Gets or sets the user-editable completion or progress label.
Publisher 7.10
string Publisher { get; set; }Gets or sets the publisher metadata.
Publishers 7.10
string[] Publishers { get; }Gets the individual publishers parsed from the publisher metadata.
Rating 7.10
string Rating { get; set; }Gets or sets the content-rating text.
RatingImage 7.10
System.Drawing.Image RatingImage { get; }Gets the image representing the game's content rating.
Region 7.10
string Region { get; set; }Gets or sets the regional release label.
ReleaseDate 7.10
System.DateTime? ReleaseDate { get; set; }Gets or sets the release date, or null when unknown.
ReleaseType 11.3
string ReleaseType { get; set; }Gets or sets the release classification, such as a released game or prototype.
ReleaseYear 7.10
int? ReleaseYear { get; set; }Gets or sets the release year, or null when unknown.
RootFolder 7.10
string RootFolder { get; set; }Gets or sets the game's root directory used for installation files.
ScreenshotImagePath 7.10
string ScreenshotImagePath { get; }Gets the selected screenshot image path.
ScummVmAspectCorrection 7.10
bool ScummVmAspectCorrection { get; set; }Gets or sets whether ScummVM should correct the aspect ratio.
ScummVmFullscreen 7.10
bool ScummVmFullscreen { get; set; }Gets or sets whether ScummVM should start in fullscreen mode.
ScummVmGameDataFolderPath 7.10
string ScummVmGameDataFolderPath { get; set; }Gets or sets the directory containing the ScummVM game data.
ScummVmGameType 7.10
string ScummVmGameType { get; set; }Gets or sets the ScummVM game identifier used to select the game engine.
Series 7.10
string Series { get; set; }Gets or sets the series metadata.
SeriesValues 7.10
string[] SeriesValues { get; }Gets the individual series parsed from the series metadata.
ShowBack 7.10
bool ShowBack { get; set; }Gets or sets whether the back of the game box is selected for display.
SortTitle 7.10
string SortTitle { get; set; }Gets or sets the alternate title used for sorting.
SortTitleOrTitle 7.10
string SortTitleOrTitle { get; }Gets the sorting title, falling back to the display title when no sorting title is set.
Source 7.10
string Source { get; set; }Gets or sets the game's import source or other source description.
StarRating 7.10
int StarRating { get; set; }
Gets or sets the star rating as an Integer value. Deprecated; please use StarRatingFloat instead.
StarRatingFloat 8.0
float StarRatingFloat { get; set; }
Gets or sets the star rating as a Float value. Should be used instead of the original StarRating property.
StartupLoadDelay 9.4
int StartupLoadDelay { get; set; }Gets or sets the startup load delay in milliseconds.
StartupScreenPostLaunchDisplayTime 14.0
int StartupScreenPostLaunchDisplayTime { get; set; }Gets or sets the time in milliseconds to keep the startup screen visible after launch.
Status 7.10
string Status { get; set; }Gets or sets the user-editable game status text.
ThemeVideoPath 7.10
string ThemeVideoPath { get; set; }Gets or sets the configured theme-video path.
Title 7.10
string Title { get; set; }Gets or sets the game title.
UseDosBox 7.10
bool UseDosBox { get; set; }Gets or sets whether to launch the game using DOSBox.
UseScummVm 7.10
bool UseScummVm { get; set; }Gets or sets whether to launch the game using ScummVM.
UseStartupScreen 9.4
bool UseStartupScreen { get; set; }Gets or sets whether to display a startup screen when launching this game.
Version 7.10
string Version { get; set; }Gets or sets the game version or edition label.
VideoPath 7.10
string VideoPath { get; set; }Gets or sets the configured video path.
VideoUrl 11.3
string VideoUrl { get; set; }Gets or sets the source URL associated with the game video.
WikipediaId 7.10
int? WikipediaId { get; set; }Gets or sets the Wikipedia page identifier, or null when unknown.
WikipediaUrl 7.10
string WikipediaUrl { get; set; }Gets or sets the URL of the associated Wikipedia page.
Methods
bool AddControllerSupport(string controllerName, string controllerCategory, int? supportLevel)Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication AddNewAdditionalApplication()Unbroken.LaunchBox.Plugins.Data.IAlternateName AddNewAlternateName()Unbroken.LaunchBox.Plugins.Data.ICustomField AddNewCustomField()Unbroken.LaunchBox.Plugins.Data.IMount AddNewMount()string Configure()Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication[]? GetAllAdditionalApplications()Unbroken.LaunchBox.Plugins.Data.IAlternateName[] GetAllAlternateNames()Unbroken.LaunchBox.Plugins.Data.ICustomField[] GetAllCustomFields()Unbroken.LaunchBox.Plugins.Data.ImageDetails[] GetAllImagesWithDetails()Unbroken.LaunchBox.Plugins.Data.ImageDetails[] GetAllImagesWithDetails(string imageType)Unbroken.LaunchBox.Plugins.Data.IMount[] GetAllMounts()string GetBigBoxDetails(bool showPlatform)System.Collections.Generic.KeyValuePair<Unbroken.LaunchBox.Plugins.Data.IGameController, int?>[] GetControllerSupport()string GetEffectiveCommandLine()string GetManualPath()string GetMusicPath()string GetNewManualFilePath(string extension)string GetNewMusicFilePath(string extension)string GetNewThemeVideoFilePath(string extension)string GetNewVideoFilePath(string extension)string GetNextAvailableImageFilePath(string extension, string imageType, string region)string GetNextVideoFilePath(string videoType, string extension)string GetThemeVideoPath()string GetVideoPath(bool prioritizeThemeVideos = false)string GetVideoPath(string videoType)string OpenFolder()string OpenManual()string Play()bool TryRemoveAdditionalApplication(Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication additionalApplication)bool TryRemoveAlternateNames(Unbroken.LaunchBox.Plugins.Data.IAlternateName alternateName)bool TryRemoveCustomField(Unbroken.LaunchBox.Plugins.Data.ICustomField customField)bool TryRemoveMount(Unbroken.LaunchBox.Plugins.Data.IMount mount)void UpdateTitleAndMigrateMedia(string newTitle)
AddControllerSupport 11.12
bool AddControllerSupport(string controllerName, string controllerCategory, int? supportLevel)
Add a controller support record to this game
controllerName11.12- The name of the controller
controllerCategory11.12- The category of the controller. This will not be used if the user already has a controller by this name
supportLevel11.12- The support level of this controller.
Returns
true if the support record was added or updated; otherwise, false.
AddNewAdditionalApplication 7.10
Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication AddNewAdditionalApplication()Creates and adds a new additional application.
Returns
The new object, which the caller can populate.AddNewAlternateName 11.3
Unbroken.LaunchBox.Plugins.Data.IAlternateName AddNewAlternateName()Creates and adds a new alternate name.
Returns
The new object, which the caller can populate.AddNewCustomField 7.10
Unbroken.LaunchBox.Plugins.Data.ICustomField AddNewCustomField()Creates and adds a new custom field.
Returns
The new object, which the caller can populate.AddNewMount 7.10
Unbroken.LaunchBox.Plugins.Data.IMount AddNewMount()Creates and adds a new DOSBox mount.
Returns
The new object, which the caller can populate.Configure 7.10
string Configure()Launches the game's configuration application using its configured launch settings.
Returns
An error message if the operation fails, or null when it succeeds.GetAllAdditionalApplications 7.10
Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication[]? GetAllAdditionalApplications()Returns the additional applications assigned to the game.
Returns
The additional applications assigned to the game.GetAllAlternateNames 11.3
Unbroken.LaunchBox.Plugins.Data.IAlternateName[] GetAllAlternateNames()Returns the alternate names assigned to the game.
Returns
The alternate names assigned to the game.GetAllCustomFields 7.10
Unbroken.LaunchBox.Plugins.Data.ICustomField[] GetAllCustomFields()Returns the custom fields assigned to the game.
Returns
The custom fields assigned to the game.GetAllImagesWithDetails 7.10
Unbroken.LaunchBox.Plugins.Data.ImageDetails[] GetAllImagesWithDetails()
Gets details on all images that are associated with this Game in the user's collection, including image path, image type, and region information.
Returns
An array of Unbroken.LaunchBox.Plugins.Data.ImageDetails objects that represent all of the game's images.GetAllImagesWithDetails 7.10
Unbroken.LaunchBox.Plugins.Data.ImageDetails[] GetAllImagesWithDetails(string imageType)
Gets details on all images of a particular image type that are associated with this Game in the user's collection, including image path, image type, and region information.
imageType7.10- The type of images to retrieve. Maps up to one of the constant values in the Unbroken.LaunchBox.Plugins.Data.ImageTypes class.
Returns
An array of Unbroken.LaunchBox.Plugins.Data.ImageDetails objects that represent all of the game's images of the specified type.GetAllMounts 7.10
Unbroken.LaunchBox.Plugins.Data.IMount[] GetAllMounts()Returns the DOSBox mounts assigned to the game.
Returns
The DOSBox mounts assigned to the game.GetBigBoxDetails 7.15
string GetBigBoxDetails(bool showPlatform)Formats game details using the current Big Box display settings.
showPlatform7.15- Whether the platform may be included when enabled by the display settings.
Returns
The formatted details text.GetControllerSupport 11.12
System.Collections.Generic.KeyValuePair<Unbroken.LaunchBox.Plugins.Data.IGameController, int?>[] GetControllerSupport()
Gets all the controller support records for this game
Returns
An array of GameControllers and their support levels associated to this gameGetEffectiveCommandLine 13.16
string GetEffectiveCommandLine()
This will get the command line that is used when this game 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 game doesn't override it.
Returns
The command line sent to the process that starts the gameGetManualPath 7.10
string GetManualPath()Resolves the game's manual using its configured paths and media folders.
Returns
The configured or discovered file path, or null or an empty string when no path is available.GetMusicPath 7.10
string GetMusicPath()Resolves the game's music file using its configured paths and media folders.
Returns
The configured or discovered file path, or null or an empty string when no path is available.GetNewManualFilePath 7.10
string GetNewManualFilePath(string extension)Builds a destination path for a game manual.
extension7.10- The file extension, including its leading period.
Returns
The destination file path; this call does not write the media file.GetNewMusicFilePath 7.10
string GetNewMusicFilePath(string extension)Builds a destination path for a game music file.
extension7.10- The file extension, including its leading period.
Returns
The destination file path; this call does not write the media file.GetNewThemeVideoFilePath 7.10
string GetNewThemeVideoFilePath(string extension)Builds a destination path for a game theme video.
extension7.10- The file extension, including its leading period.
Returns
The destination file path; this call does not write the media file.GetNewVideoFilePath 7.10
Obsolete since 11.0
string GetNewVideoFilePath(string extension)Builds a destination path for a game video snap.
extension7.10- The file extension, including its leading period.
Returns
The destination file path; this call does not write the media file.GetNextAvailableImageFilePath 7.10
string GetNextAvailableImageFilePath(string extension, string imageType, string region)Builds a destination path for a game image.
extension7.10- The file extension, including its leading period.
imageType7.10- The image category that determines the destination folder.
region7.10- The regional variant used for the destination image.
Returns
The destination file path; this call does not write the media file.GetNextVideoFilePath 11.0
string GetNextVideoFilePath(string videoType, string extension)GetThemeVideoPath 7.10
string GetThemeVideoPath()Resolves the game's theme video using its configured paths and media folders.
Returns
The configured or discovered file path, or null or an empty string when no path is available.GetVideoPath 7.10
string GetVideoPath(bool prioritizeThemeVideos = false)Resolves the game's video using its configured paths and media folders.
prioritizeThemeVideos7.10- Whether theme videos take priority over ordinary game videos.
Returns
The configured or discovered file path, or null or an empty string when no path is available.GetVideoPath 11.0
string GetVideoPath(string videoType)Resolves the game's video using its configured paths and media folders.
videoType11.0- The video category to resolve.
Returns
The configured or discovered file path, or null or an empty string when no path is available.OpenFolder 7.10
string OpenFolder()Opens the game directory in the system file browser.
Returns
An error message if the operation fails, or null when it succeeds.OpenManual 7.10
string OpenManual()Opens the game manual in the configured document viewer.
Returns
An error message if the operation fails, or null when it succeeds.Play 7.10
string Play()
Launches the game. Does not use the startup screen or any other part of the launching process other than simply launching the game. If you're looking to use the whole process with startup screens, please use PluginHelper.LaunchBoxMainViewModel.PlayGame or PluginHelper.BigBoxMainViewModel.PlayGame instead.
Returns
An error message, ornull if no launch error was reported.
TryRemoveAdditionalApplication 7.10
bool TryRemoveAdditionalApplication(Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication additionalApplication)Attempts to remove the specified additional application.
additionalApplication7.10- The additional application to remove.
Returns
Whether the object was removed.TryRemoveAlternateNames 11.3
bool TryRemoveAlternateNames(Unbroken.LaunchBox.Plugins.Data.IAlternateName alternateName)Attempts to remove the specified alternate name.
alternateName11.3- The alternate name to remove.
Returns
Whether the object was removed.TryRemoveCustomField 7.10
bool TryRemoveCustomField(Unbroken.LaunchBox.Plugins.Data.ICustomField customField)Attempts to remove the specified custom field.
customField7.10- The custom field to remove.
Returns
Whether the object was removed.TryRemoveMount 7.10
bool TryRemoveMount(Unbroken.LaunchBox.Plugins.Data.IMount mount)Attempts to remove the specified DOSBox mount.
mount7.10- The DOSBox mount to remove.
Returns
Whether the object was removed.UpdateTitleAndMigrateMedia 11.13
void UpdateTitleAndMigrateMedia(string newTitle)
This will allow you to rename the game as well as all associated media
newTitle11.13- The title you are changing the game to