LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IEmulatorSaveManager14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Emulators.IEmulatorSaveManager
Discovers, adds, removes, groups, and backs up save files owned by an external emulator.

Methods

AddSaveFile 14.1 Beta

C#
Unbroken.LaunchBox.Plugins.Emulators.EmulatorSaveAddResult AddSaveFile(Unbroken.LaunchBox.Plugins.Emulators.EmulatorSaveAddRequest request)
Adds a save file to the emulator for a game.
request 14.1 Beta
The game, emulator, source file, and target slot context.

Returns

The add-save result.

GetCompanionSaveFiles 14.1 Beta

C#
System.Collections.Generic.IReadOnlyList<string> GetCompanionSaveFiles(string primaryFilePath)
Gets additional files that must be handled with a primary save file.
primaryFilePath 14.1 Beta
The primary save-file path.

Returns

The companion save-file paths.

GetPotentialSaveSlots 14.1 Beta

C#
System.Collections.Generic.IReadOnlyDictionary<int, string> GetPotentialSaveSlots()
Gets the save-slot identifiers and display labels supported by the emulator.

Returns

A mapping from slot number to display label.

GetSaves 14.1 Beta

C#
Unbroken.LaunchBox.Plugins.Emulators.EmulatorSaveDiscoveryResult GetSaves(Unbroken.LaunchBox.Plugins.Emulators.EmulatorSaveDiscoveryRequest request)
Gets the save files associated with a game and emulator.
request 14.1 Beta
The game and emulator context.

Returns

The save-discovery result.

IsSaveActive 14.1 Beta

C#
bool IsSaveActive(Unbroken.LaunchBox.Plugins.Data.GameSaveBase save, string emulatorApplicationPath)
Determines whether a save is the emulator's active copy.
save 14.1 Beta
The save to inspect.
emulatorApplicationPath 14.1 Beta
The path to the emulator executable.

Returns

true when the save is active.

IsSaveContainer 14.1 Beta

C#
bool IsSaveContainer(Unbroken.LaunchBox.Plugins.Data.GameSaveBase save)
Determines whether a save represents a container whose contents must be handled together.
save 14.1 Beta
The save to inspect.

Returns

true when the save is a container.

IsSecondarySaveFile 14.1 Beta

C#
bool IsSecondarySaveFile(string filePath)
Determines whether a path is a secondary file belonging to another primary save.
filePath 14.1 Beta
The file path to inspect.

Returns

true when the path is a secondary save file.

RemoveSave 14.1 Beta

C#
Unbroken.LaunchBox.Plugins.PluginResponse RemoveSave(Unbroken.LaunchBox.Plugins.Data.GameSaveBase? save)
Removes a save from the emulator.
save 14.1 Beta
The save to remove.

Returns

Whether the save was removed successfully.

TryBackupSave 14.1 Beta

C#
bool TryBackupSave(Unbroken.LaunchBox.Plugins.Data.GameSaveBase save, string emulatorApplicationPath, string destinationFolder, out string? error)
Attempts to copy a save and related files into a backup folder.
save 14.1 Beta
The save to back up.
emulatorApplicationPath 14.1 Beta
The path to the emulator executable.
destinationFolder 14.1 Beta
The destination folder for the backup.
error 14.1 Beta
An error message when the backup fails.

Returns

true when the backup was created.

TryComputeSaveSignature 14.1 Beta

C#
bool TryComputeSaveSignature(Unbroken.LaunchBox.Plugins.Data.GameSaveBase save, string emulatorApplicationPath, out string? signature)
Attempts to compute a stable signature for a save's current contents.
save 14.1 Beta
The save to inspect.
emulatorApplicationPath 14.1 Beta
The path to the emulator executable.
signature 14.1 Beta
The computed signature when successful.

Returns

true when a signature was computed.

TryGetSaveGroupInfo 14.1 Beta

C#
bool TryGetSaveGroupInfo(Unbroken.LaunchBox.Plugins.Data.GameSaveBase save, string primaryFilePath, out string? saveGroupId, out string? saveGroupName)
Attempts to resolve grouping information for a primary save file.
save 14.1 Beta
The save to inspect.
primaryFilePath 14.1 Beta
The primary save-file path.
saveGroupId 14.1 Beta
The stable group identifier when successful.
saveGroupName 14.1 Beta
The display name for the group when successful.

Returns

true when grouping information was resolved.

UseSaveGroupIdForPersistedMatch 14.1 Beta

C#
bool UseSaveGroupIdForPersistedMatch(Unbroken.LaunchBox.Plugins.Data.GameSaveBase save)
Determines whether persisted matching should use the save's group identifier.
save 14.1 Beta
The save to inspect.

Returns

true when persisted matching should use the group identifier.