DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Class Config   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Class Config   ">    <meta name="generator" content="docfx 2.44.0.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">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </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 class="container body-content">                <div id="search-results">          <div class="search-list"></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination"></ul>        </div>      </div>      <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="IPA.Config.Config">      <h1 id="IPA_Config_Config" data-uid="IPA.Config.Config" class="text-break">Class Config  </h1>  <div class="markdown level0 summary"><p>A class to handle updating ConfigProviders automatically</p></div>  <div class="markdown level0 conceptual"></div>  <div class="inheritance">    <h5>Inheritance</h5>    <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>    <div class="level1"><span class="xref">Config</span></div>  </div>  <div class="inheritedMembers">    <h5>Inherited Members</h5>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>    </div>  </div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Config_Config_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static class Config</code></pre>  </div>  <h3 id="methods">Methods  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_GetProviderFor_System_String_System_String___.md&amp;value=---%0Auid%3A%20IPA.Config.Config.GetProviderFor(System.String%2CSystem.String%5B%5D)%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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/14c25b1c98852b260e353db7a61ae4087f67995b/IPA.Loader/Config/Config.cs/#L133">View Source</a>  </span>  <a id="IPA_Config_Config_GetProviderFor_" data-uid="IPA.Config.Config.GetProviderFor*"></a>  <h4 id="IPA_Config_Config_GetProviderFor_System_String_System_String___" data-uid="IPA.Config.Config.GetProviderFor(System.String,System.String[])">GetProviderFor(String, String[])</h4>  <div class="markdown level1 summary"><p>Gets an <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a> using the specified list of preferred config types.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static IConfigProvider GetProviderFor(string configName, params string[] extensions)</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="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>        <td><span class="parametername">configName</span></td>        <td><p>the name of the mod for this config</p></td>      </tr>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>[]</td>        <td><span class="parametername">extensions</span></td>        <td><p>the preferred config types to try to get</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="IPA.Config.IConfigProvider.html">IConfigProvider</a></td>        <td><p>an <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a> of the requested type, or of type JSON.</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_MakeLink__1_IPA_Config_IConfigProvider_System_Action_IPA_Config_IConfigProvider_IPA_Utilities_Ref___0___.md&amp;value=---%0Auid%3A%20IPA.Config.Config.MakeLink%60%601(IPA.Config.IConfigProvider%2CSystem.Action%7BIPA.Config.IConfigProvider%2CIPA.Utilities.Ref%7B%60%600%7D%7D)%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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/14c25b1c98852b260e353db7a61ae4087f67995b/IPA.Loader/Config/Config.cs/#L168">View Source</a>  </span>  <a id="IPA_Config_Config_MakeLink_" data-uid="IPA.Config.Config.MakeLink*"></a>  <h4 id="IPA_Config_Config_MakeLink__1_IPA_Config_IConfigProvider_System_Action_IPA_Config_IConfigProvider_IPA_Utilities_Ref___0___" data-uid="IPA.Config.Config.MakeLink``1(IPA.Config.IConfigProvider,System.Action{IPA.Config.IConfigProvider,IPA.Utilities.Ref{``0}})">MakeLink&lt;T&gt;(IConfigProvider, Action&lt;IConfigProvider, Ref&lt;T&gt;&gt;)</h4>  <div class="markdown level1 summary"><p>Creates a linked <a class="xref" href="IPA.Utilities.Ref-1.html">Ref&lt;T&gt;</a> for the config provider. This <a class="xref" href="IPA.Utilities.Ref-1.html">Ref&lt;T&gt;</a> will be automatically updated whenever the file on-disk changes.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static Ref&lt;T&gt; MakeLink&lt;T&gt;(this IConfigProvider config, Action&lt;IConfigProvider, Ref&lt;T&gt;&gt; onChange = null)</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="IPA.Config.IConfigProvider.html">IConfigProvider</a></td>        <td><span class="parametername">config</span></td>        <td><p>the <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a> to create a link to</p></td>      </tr>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-2">Action</a>&lt;<a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a>, <a class="xref" href="IPA.Utilities.Ref-1.html">Ref</a>&lt;T&gt;&gt;</td>        <td><span class="parametername">onChange</span></td>        <td><p>an action to perform on value change</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="IPA.Utilities.Ref-1.html">Ref</a>&lt;T&gt;</td>        <td><p>a <a class="xref" href="IPA.Utilities.Ref-1.html">Ref&lt;T&gt;</a> to an ever-changing value, mirroring whatever the file contains.</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>the type of the parsed value</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_Register_System_Type_.md&amp;value=---%0Auid%3A%20IPA.Config.Config.Register(System.Type)%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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/14c25b1c98852b260e353db7a61ae4087f67995b/IPA.Loader/Config/Config.cs/#L111">View Source</a>  </span>  <a id="IPA_Config_Config_Register_" data-uid="IPA.Config.Config.Register*"></a>  <h4 id="IPA_Config_Config_Register_System_Type_" data-uid="IPA.Config.Config.Register(System.Type)">Register(Type)</h4>  <div class="markdown level1 summary"><p>Registers a <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a> to use for configs.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static void Register(Type type)</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="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>        <td><span class="parametername">type</span></td>        <td><p>the type to register</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_Register__1.md&amp;value=---%0Auid%3A%20IPA.Config.Config.Register%60%601%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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/14c25b1c98852b260e353db7a61ae4087f67995b/IPA.Loader/Config/Config.cs/#L105">View Source</a>  </span>  <a id="IPA_Config_Config_Register_" data-uid="IPA.Config.Config.Register*"></a>  <h4 id="IPA_Config_Config_Register__1" data-uid="IPA.Config.Config.Register``1">Register&lt;T&gt;()</h4>  <div class="markdown level1 summary"><p>Registers a <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a> to use for configs.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static void Register&lt;T&gt;()    where T : IConfigProvider</code></pre>  </div>  <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>the type to register</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_RemoveLinks_IPA_Config_IConfigProvider_.md&amp;value=---%0Auid%3A%20IPA.Config.Config.RemoveLinks(IPA.Config.IConfigProvider)%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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/14c25b1c98852b260e353db7a61ae4087f67995b/IPA.Loader/Config/Config.cs/#L191">View Source</a>  </span>  <a id="IPA_Config_Config_RemoveLinks_" data-uid="IPA.Config.Config.RemoveLinks*"></a>  <h4 id="IPA_Config_Config_RemoveLinks_IPA_Config_IConfigProvider_" data-uid="IPA.Config.Config.RemoveLinks(IPA.Config.IConfigProvider)">RemoveLinks(IConfigProvider)</h4>  <div class="markdown level1 summary"><p>Removes all linked <a class="xref" href="IPA.Utilities.Ref-1.html">Ref&lt;T&gt;</a> such that they are no longer updated.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static void RemoveLinks(this IConfigProvider config)</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="IPA.Config.IConfigProvider.html">IConfigProvider</a></td>        <td><span class="parametername">config</span></td>        <td><p>the <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a> to unlink</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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config.md&amp;value=---%0Auid%3A%20IPA.Config.Config%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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/14c25b1c98852b260e353db7a61ae4087f67995b/IPA.Loader/Config/Config.cs/#L18" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->              </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>