DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git
1
1
Fork 0
Code Issues 0 Projects 0 Releases 78 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
138 Commits
9 Branches
250 MiB
Tree: 4d9a59e7a2
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4d9a59e7a2'
${ noResults }
BeatSaber-IPA-Reloaded/branch/4.0.0-beta/api/IPA.Config.IConfigProvider....

310 lines
16 KiB
Raw Normal View History

Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- Allowed failures building .NET 3 in CI
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- Allowed failures building .NET 3 in CI
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- Allowed failures building .NET 3 in CI
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- ReflectionUtil documentation
4 years ago
​
​
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- Allowed failures building .NET 3 in CI
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4.   
  5.   <head>
  6.     <meta charset="utf-8">
  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  8.     <title>Interface IConfigProvider
  9.    </title>
  10.     <meta name="viewport" content="width=device-width">
  11.     <meta name="title" content="Interface IConfigProvider
  12.    ">
  13.     <meta name="generator" content="docfx 2.48.0.0">
  14.     
  15.     <link rel="shortcut icon" href="../favicon.ico">
  16.     <link rel="stylesheet" href="../styles/docfx.vendor.css">
  17.     <link rel="stylesheet" href="../styles/docfx.css">
  18.     <link rel="stylesheet" href="../styles/main.css">
  19.     <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
  20.     <meta property="docfx:navrel" content="../toc.html">
  21.     <meta property="docfx:tocrel" content="toc.html">
  22.     
  23.     <meta property="docfx:rel" content="../">
  24.     <meta property="docfx:newtab" content="true">
  25.   </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
  26.     <div id="wrapper">
  27.       <header>
  28.         
  29.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  30.           <div class="container">
  31.             <div class="navbar-header">
  32.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  33.                 <span class="sr-only">Toggle navigation</span>
  34.                 <span class="icon-bar"></span>
  35.                 <span class="icon-bar"></span>
  36.                 <span class="icon-bar"></span>
  37.               </button>
  38.               
  39.               <a class="navbar-brand" href="../index.html">
  40.                 <img id="logo" class="svg" src="../logo.svg" alt="">
  41.               </a>
  42.             </div>
  43.             <div class="collapse navbar-collapse" id="navbar">
  44.               <form class="navbar-form navbar-right" role="search" id="search">
  45.                 <div class="form-group">
  46.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  47.                 </div>
  48.               </form>
  49.             </div>
  50.           </div>
  51.         </nav>
  52.         
  53.         <div class="subnav navbar navbar-default">
  54.           <div class="container hide-when-search" id="breadcrumb">
  55.             <ul class="breadcrumb">
  56.               <li></li>
  57.             </ul>
  58.           </div>
  59.         </div>
  60.       </header>
  61.       <div class="container body-content">
  62.         
  63.         <div id="search-results">
  64.           <div class="search-list"></div>
  65.           <div class="sr-items">
  66.             <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  67.           </div>
  68.           <ul id="pagination"></ul>
  69.         </div>
  70.       </div>
  71.       <div role="main" class="container body-content hide-when-search">
  72.         
  73.         <div class="sidenav hide-when-search">
  74.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  75.           <div class="sidetoggle collapse" id="sidetoggle">
  76.             <div id="sidetoc"></div>
  77.           </div>
  78.         </div>
  79.         <div class="article row grid-right">
  80.           <div class="col-md-10">
  81.             <article class="content wrap" id="_content" data-uid="IPA.Config.IConfigProvider">
  82.   
  83.   
  84.   <h1 id="IPA_Config_IConfigProvider" data-uid="IPA.Config.IConfigProvider" class="text-break">Interface IConfigProvider
  85.   </h1>
  86.   <div class="markdown level0 summary"><p>An interface for configuration providers.</p>
  87. </div>
  88.   <div class="markdown level0 conceptual"></div>
  89.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  90.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  91.   <h5 id="IPA_Config_IConfigProvider_syntax">Syntax</h5>
  92.   <div class="codewrapper">
  93.     <pre><code class="lang-csharp hljs">public interface IConfigProvider</code></pre>
  94.   </div>
  95.   <h5 id="IPA_Config_IConfigProvider_remarks"><strong>Remarks</strong></h5>
  96.   <div class="markdown level0 remarks"><p>
  97. Implementers must provide a default constructor. Do not assume that <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.file">File</a> will ever be set for a given object.
  98. </p>
  99. <p>
  100. Implementers are expected to preserve the typing of values passed to <a class="xref" href="IPA.Config.IConfigProvider.html#IPA_Config_IConfigProvider_Store_IPA_Config_Data_Value_System_IO_FileInfo_">Store(Value, FileInfo)</a> when returned from <a class="xref" href="IPA.Config.IConfigProvider.html#IPA_Config_IConfigProvider_Load_System_IO_FileInfo_">Load(FileInfo)</a>.
  101. The only exceptions to this are the numeric types, <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> and <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>, since they can be coerced
  102. to each other with <a class="xref" href="IPA.Config.Data.Integer.html#IPA_Config_Data_Integer_AsFloat">AsFloat()</a> and <a class="xref" href="IPA.Config.Data.FloatingPoint.html#IPA_Config_Data_FloatingPoint_AsInteger">AsInteger()</a> respectively. The provider <em>should</em>
  103. however store and recover <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> with as much precision as is possible. For example, a JSON provider may decide to
  104. decode all numbers that have an integral value, even if they were originally <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>, as <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a>.
  105. This is reasonable, as <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> is more precise, particularly with larger values, than <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>.
  106. </p>
  107. </div>
  108.   <h3 id="properties">Properties
  109.   </h3>
  110.   <span class="small pull-right mobile-hide">
  111.     <span class="divider">|</span>
  112.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_IConfigProvider_Extension.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigProvider.Extension%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>
  113.   </span>
  114.   <span class="small pull-right mobile-hide">
  115.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/674742a4156d8375ece0cb7bf8a48df6d5ebc7de/IPA.Loader/Config/IConfigProvider.cs/#L33">View Source</a>
  116.   </span>
  117.   <a id="IPA_Config_IConfigProvider_Extension_" data-uid="IPA.Config.IConfigProvider.Extension*"></a>
  118.   <h4 id="IPA_Config_IConfigProvider_Extension" data-uid="IPA.Config.IConfigProvider.Extension">Extension</h4>
  119.   <div class="markdown level1 summary"><p>Gets the extension <em>without</em> a dot to use for files handled by this provider.</p>
  120. </div>
  121.   <div class="markdown level1 conceptual"></div>
  122.   <h5 class="decalaration">Declaration</h5>
  123.   <div class="codewrapper">
  124.     <pre><code class="lang-csharp hljs">string Extension { get; }</code></pre>
  125.   </div>
  126.   <h5 class="propertyValue">Property Value</h5>
  127.   <table class="table table-bordered table-striped table-condensed">
  128.     <thead>
  129.       <tr>
  130.         <th>Type</th>
  131.         <th>Description</th>
  132.       </tr>
  133.     </thead>
  134.     <tbody>
  135.       <tr>
  136.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  137.         <td></td>
  138.       </tr>
  139.     </tbody>
  140.   </table>
  141.   <h5 id="IPA_Config_IConfigProvider_Extension_remarks">Remarks</h5>
  142.   <div class="markdown level1 remarks"><p>This must work immediately, and is used to generate the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a> used to set
  143. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.file">File</a>.</p>
  144. </div>
  145.   <h3 id="methods">Methods
  146.   </h3>
  147.   <span class="small pull-right mobile-hide">
  148.     <span class="divider">|</span>
  149.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_IConfigProvider_Load_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigProvider.Load(System.IO.FileInfo)%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>
  150.   </span>
  151.   <span class="small pull-right mobile-hide">
  152.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/674742a4156d8375ece0cb7bf8a48df6d5ebc7de/IPA.Loader/Config/IConfigProvider.cs/#L48">View Source</a>
  153.   </span>
  154.   <a id="IPA_Config_IConfigProvider_Load_" data-uid="IPA.Config.IConfigProvider.Load*"></a>
  155.   <h4 id="IPA_Config_IConfigProvider_Load_System_IO_FileInfo_" data-uid="IPA.Config.IConfigProvider.Load(System.IO.FileInfo)">Load(FileInfo)</h4>
  156.   <div class="markdown level1 summary"><p>Loads a <a class="xref" href="IPA.Config.Data.Value.html">Value</a> from disk in whatever format this provider provides
  157. and returns it.</p>
  158. </div>
  159.   <div class="markdown level1 conceptual"></div>
  160.   <h5 class="decalaration">Declaration</h5>
  161.   <div class="codewrapper">
  162.     <pre><code class="lang-csharp hljs">Value Load(FileInfo file)</code></pre>
  163.   </div>
  164.   <h5 class="parameters">Parameters</h5>
  165.   <table class="table table-bordered table-striped table-condensed">
  166.     <thead>
  167.       <tr>
  168.         <th>Type</th>
  169.         <th>Name</th>
  170.         <th>Description</th>
  171.       </tr>
  172.     </thead>
  173.     <tbody>
  174.       <tr>
  175.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
  176.         <td><span class="parametername">file</span></td>
  177.         <td><p>the file to read from</p>
  178. </td>
  179.       </tr>
  180.     </tbody>
  181.   </table>
  182.   <h5 class="returns">Returns</h5>
  183.   <table class="table table-bordered table-striped table-condensed">
  184.     <thead>
  185.       <tr>
  186.         <th>Type</th>
  187.         <th>Description</th>
  188.       </tr>
  189.     </thead>
  190.     <tbody>
  191.       <tr>
  192.         <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  193.         <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> loaded</p>
  194. </td>
  195.       </tr>
  196.     </tbody>
  197.   </table>
  198.   <span class="small pull-right mobile-hide">
  199.     <span class="divider">|</span>
  200.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_IConfigProvider_Store_IPA_Config_Data_Value_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigProvider.Store(IPA.Config.Data.Value%2CSystem.IO.FileInfo)%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>
  201.   </span>
  202.   <span class="small pull-right mobile-hide">
  203.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/674742a4156d8375ece0cb7bf8a48df6d5ebc7de/IPA.Loader/Config/IConfigProvider.cs/#L40">View Source</a>
  204.   </span>
  205.   <a id="IPA_Config_IConfigProvider_Store_" data-uid="IPA.Config.IConfigProvider.Store*"></a>
  206.   <h4 id="IPA_Config_IConfigProvider_Store_IPA_Config_Data_Value_System_IO_FileInfo_" data-uid="IPA.Config.IConfigProvider.Store(IPA.Config.Data.Value,System.IO.FileInfo)">Store(Value, FileInfo)</h4>
  207.   <div class="markdown level1 summary"><p>Stores the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> given to disk in the format specified.</p>
  208. </div>
  209.   <div class="markdown level1 conceptual"></div>
  210.   <h5 class="decalaration">Declaration</h5>
  211.   <div class="codewrapper">
  212.     <pre><code class="lang-csharp hljs">void Store(Value value, FileInfo file)</code></pre>
  213.   </div>
  214.   <h5 class="parameters">Parameters</h5>
  215.   <table class="table table-bordered table-striped table-condensed">
  216.     <thead>
  217.       <tr>
  218.         <th>Type</th>
  219.         <th>Name</th>
  220.         <th>Description</th>
  221.       </tr>
  222.     </thead>
  223.     <tbody>
  224.       <tr>
  225.         <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  226.         <td><span class="parametername">value</span></td>
  227.         <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to store</p>
  228. </td>
  229.       </tr>
  230.       <tr>
  231.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
  232.         <td><span class="parametername">file</span></td>
  233.         <td><p>the file to write to</p>
  234. </td>
  235.       </tr>
  236.     </tbody>
  237.   </table>
  238.   <h3 id="extensionmethods">Extension Methods</h3>
  239.   <div>
  240.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField_System_Object_System_String_System_Object_">ReflectionUtil.SetField(Object, String, Object)</a>
  241.   </div>
  242.   <div>
  243.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__1___0_System_String_System_Object_">ReflectionUtil.SetField&lt;T&gt;(T, String, Object)</a>
  244.   </div>
  245.   <div>
  246.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__1_System_Object_System_String_">ReflectionUtil.GetField&lt;T&gt;(Object, String)</a>
  247.   </div>
  248.   <div>
  249.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;T, U&gt;(U, String)</a>
  250.   </div>
  251.   <div>
  252.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetProperty(Object, String, Object)</a>
  253.   </div>
  254.   <div>
  255.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__1___0_System_String_System_Object_">ReflectionUtil.SetProperty&lt;T&gt;(T, String, Object)</a>
  256.   </div>
  257.   <div>
  258.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod(Object, String, Object[])</a>
  259.   </div>
  260.   <div>
  261.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1___0_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(T, String, Object[])</a>
  262.   </div>
  263.   <div>
  264.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(Object, String, Object[])</a>
  265.   </div>
  266.   <div>
  267.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T, U&gt;(U, String, Object[])</a>
  268.   </div>
  269. </article>
  270.           </div>
  271.           
  272.           <div class="hidden-sm col-md-2" role="complementary">
  273.             <div class="sideaffix">
  274.               <div class="contribution">
  275.                 <ul class="nav">
  276.                   <li>
  277.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_IConfigProvider.md&amp;value=---%0Auid%3A%20IPA.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" class="contribution-link">Improve this Doc</a>
  278.                   </li>
  279.                   <li>
  280.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/674742a4156d8375ece0cb7bf8a48df6d5ebc7de/IPA.Loader/Config/IConfigProvider.cs/#L24" class="contribution-link">View Source</a>
  281.                   </li>
  282.                 </ul>
  283.               </div>
  284.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  285.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  286.               </nav>
  287.             </div>
  288.           </div>
  289.         </div>
  290.       </div>
  291.       
  292.       <footer>
  293.         <div class="grad-bottom"></div>
  294.         <div class="footer">
  295.           <div class="container">
  296.             <span class="pull-right">
  297.               <a href="#top">Back to top</a>
  298.             </span>
  299.             
  300.             <span>Generated by <strong>DocFX</strong></span>
  301.           </div>
  302.         </div>
  303.       </footer>
  304.     </div>
  305.     
  306.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  307.     <script type="text/javascript" src="../styles/docfx.js"></script>
  308.     <script type="text/javascript" src="../styles/main.js"></script>
  309.   </body>
  310. </html>