Dalamud/docs/api/Dalamud.Configuration.PluginConfigurations.html
2021-12-06 19:14:46 +01:00

493 lines
22 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class PluginConfigurations
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PluginConfigurations
">
<meta name="generator" content="docfx 2.58.9.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Configuration.PluginConfigurations">
<h1 id="Dalamud_Configuration_PluginConfigurations" data-uid="Dalamud.Configuration.PluginConfigurations" class="text-break">Class PluginConfigurations
</h1>
<div class="markdown level0 summary"><p>Configuration to store settings for a dalamud plugin.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">PluginConfigurations</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Configuration.html">Dalamud.Configuration</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Configuration_PluginConfigurations_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class PluginConfigurations</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations__ctor_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.%23ctor(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L18">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations__ctor_" data-uid="Dalamud.Configuration.PluginConfigurations.#ctor*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations__ctor_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.#ctor(System.String)">PluginConfigurations(String)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Configuration.PluginConfigurations.html">PluginConfigurations</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PluginConfigurations(string storageFolder)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">storageFolder</span></td>
<td><p>Directory for storage of plugin configuration files.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_Delete_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.Delete(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L68">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_Delete_" data-uid="Dalamud.Configuration.PluginConfigurations.Delete*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_Delete_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.Delete(System.String)">Delete(String)</h4>
<div class="markdown level1 summary"><p>Delete the configuration file and folder for the specified plugin.
This will throw an <span class="xref">System.IO.IOException</span> if the plugin did not correctly close its handles.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Delete(string pluginName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td><p>The name of the plugin.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_GetConfigFile_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.GetConfigFile(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L126">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_GetConfigFile_" data-uid="Dalamud.Configuration.PluginConfigurations.GetConfigFile*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_GetConfigFile_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.GetConfigFile(System.String)">GetConfigFile(String)</h4>
<div class="markdown level1 summary"><p>Get FileInfo to plugin config file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileInfo GetConfigFile(string pluginName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td><p>InternalName of the plugin.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.FileInfo</span></td>
<td><p>FileInfo of the config file.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_GetDirectory_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.GetDirectory(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L84">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_GetDirectory_" data-uid="Dalamud.Configuration.PluginConfigurations.GetDirectory*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_GetDirectory_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.GetDirectory(System.String)">GetDirectory(String)</h4>
<div class="markdown level1 summary"><p>Get plugin directory.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string GetDirectory(string pluginName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td><p>Plugin name.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>Plugin directory path.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_Load_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.Load(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L47">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_Load_" data-uid="Dalamud.Configuration.PluginConfigurations.Load*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_Load_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.Load(System.String)">Load(String)</h4>
<div class="markdown level1 summary"><p>Load plugin configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPluginConfiguration Load(string pluginName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td><p>Plugin name.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
<td><p>Plugin configuration.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_LoadForType__1_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.LoadForType%60%601(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L111">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_LoadForType_" data-uid="Dalamud.Configuration.PluginConfigurations.LoadForType*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_LoadForType__1_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.LoadForType``1(System.String)">LoadForType&lt;T&gt;(String)</h4>
<div class="markdown level1 summary"><p>Load Plugin configuration. Parameterized deserialization.
Currently this is called via reflection from DalamudPluginInterface.GetPluginConfig().
Eventually there may be an additional pluginInterface method that can call this directly
without reflection - for now this is in support of the existing plugin api.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T LoadForType&lt;T&gt;(string pluginName)
where T : IPluginConfiguration</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td><p>Plugin Name.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><p>Plugin Configuration.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>Configuration Type.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_Save_Dalamud_Configuration_IPluginConfiguration_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.Save(Dalamud.Configuration.IPluginConfiguration%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L33">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_Save_" data-uid="Dalamud.Configuration.PluginConfigurations.Save*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_Save_Dalamud_Configuration_IPluginConfiguration_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.Save(Dalamud.Configuration.IPluginConfiguration,System.String)">Save(IPluginConfiguration, String)</h4>
<div class="markdown level1 summary"><p>Save/Load plugin configuration.
NOTE: Save/Load are still using Type information for now,
despite LoadForType superseding Load and not requiring or using it.
It might be worth removing the Type info from Save, to strip it from all future saved configs,
and then Load() can probably be removed entirely.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Save(IPluginConfiguration config, string pluginName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
<td><span class="parametername">config</span></td>
<td><p>Plugin configuration.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td><p>Plugin name.</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L10" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>