14.1 Beta 1 SDK

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

IPluginPaths14.0

Obsolete since 14.1 Beta

Use IPluginDataStore, IPluginSecretStore, or IPluginFileSystemStore instead.

public interface Unbroken.LaunchBox.Plugins.IPluginPaths

Provides the file-system locations assigned to a plugin by LaunchBox or Big Box. A plugin can request these paths by declaring a public constructor with an Unbroken.LaunchBox.Plugins.IPluginPaths parameter.

Remarks

This service remains available for compatibility and direct access to installed package files. New plugins should use Unbroken.LaunchBox.Plugins.IPluginDataStore for persistent values, Unbroken.LaunchBox.Plugins.IPluginSecretStore for protected values, and Unbroken.LaunchBox.Plugins.IPluginFileSystemStore for plugin-managed files.

DataDirectory 14.0

string DataDirectory { get; }

Gets the directory selected by LaunchBox or Big Box for data created by the plugin at runtime. Its contents are kept separate from installation files and are not replaced when the plugin is updated or repaired. The directory is not guaranteed to exist, so the plugin should create it before writing files.

InstallDirectory 14.0

string InstallDirectory { get; }

Gets the root directory containing the installed plugin files. Treat its contents as installation files because they may be replaced when the plugin is updated or repaired.