LaunchBoxContributors
On this page

IPluginPaths14.0

Interface in Unbroken.LaunchBox.Plugins

Obsolete since 14.1

Use IPluginDataStore, IPluginSecretStore, or IPluginFileSystemStore instead.

C#
public interface 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 IPluginPaths parameter.

Remarks

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

Properties

  • DataDirectoryGets 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.
  • InstallDirectoryGets 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.

DataDirectory

C#
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

C#
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.