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.
141 Commits
9 Branches
453 MiB
Tree: 1df0877fea
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1df0877fea'
${ noResults }
BeatSaber-IPA-Reloaded/branch/4.0.0-beta/api/IPA.Config.Stores.Generated...

308 lines
15 KiB
Raw Normal View History

Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- More documentation
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- More documentation
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- More documentation
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>Class GeneratedExtension
  9.    </title>
  10.     <meta name="viewport" content="width=device-width">
  11.     <meta name="title" content="Class GeneratedExtension
  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.Stores.GeneratedExtension">
  82.   
  83.   
  84.   <h1 id="IPA_Config_Stores_GeneratedExtension" data-uid="IPA.Config.Stores.GeneratedExtension" class="text-break">Class GeneratedExtension
  85.   </h1>
  86.   <div class="markdown level0 summary"><p>A class providing an extension for <a class="xref" href="IPA.Config.Config.html">Config</a> to make it easy to use generated
  87. config stores.</p>
  88. </div>
  89.   <div class="markdown level0 conceptual"></div>
  90.   <div class="inheritance">
  91.     <h5>Inheritance</h5>
  92.     <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  93.     <div class="level1"><span class="xref">GeneratedExtension</span></div>
  94.   </div>
  95.   <div class="inheritedMembers">
  96.     <h5>Inherited Members</h5>
  97.     <div>
  98.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  99.     </div>
  100.     <div>
  101.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  102.     </div>
  103.     <div>
  104.       <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>
  105.     </div>
  106.     <div>
  107.       <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>
  108.     </div>
  109.     <div>
  110.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  111.     </div>
  112.     <div>
  113.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  114.     </div>
  115.     <div>
  116.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  117.     </div>
  118.   </div>
  119.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.html">IPA.Config.Stores</a></h6>
  120.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  121.   <h5 id="IPA_Config_Stores_GeneratedExtension_syntax">Syntax</h5>
  122.   <div class="codewrapper">
  123.     <pre><code class="lang-csharp hljs">public static class GeneratedExtension</code></pre>
  124.   </div>
  125.   <h3 id="fields">Fields
  126.   </h3>
  127.   <span class="small pull-right mobile-hide">
  128.     <span class="divider">|</span>
  129.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_Stores_GeneratedExtension_AssemblyVisibilityTarget.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.GeneratedExtension.AssemblyVisibilityTarget%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>
  130.   </span>
  131.   <span class="small pull-right mobile-hide">
  132.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/a2ab33cc30a9c138f1aa39f73a6095b740f38a68/IPA.Loader/Config/Stores/GeneratedStore.cs/#L36">View Source</a>
  133.   </span>
  134.   <h4 id="IPA_Config_Stores_GeneratedExtension_AssemblyVisibilityTarget" data-uid="IPA.Config.Stores.GeneratedExtension.AssemblyVisibilityTarget">AssemblyVisibilityTarget</h4>
  135.   <div class="markdown level1 summary"><p>The name of the assembly that internals must be visible to to allow internal protection.</p>
  136. </div>
  137.   <div class="markdown level1 conceptual"></div>
  138.   <h5 class="decalaration">Declaration</h5>
  139.   <div class="codewrapper">
  140.     <pre><code class="lang-csharp hljs">public const string AssemblyVisibilityTarget = &quot;IPA.Config.Generated&quot;</code></pre>
  141.   </div>
  142.   <h5 class="fieldValue">Field Value</h5>
  143.   <table class="table table-bordered table-striped table-condensed">
  144.     <thead>
  145.       <tr>
  146.         <th>Type</th>
  147.         <th>Description</th>
  148.       </tr>
  149.     </thead>
  150.     <tbody>
  151.       <tr>
  152.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  153.         <td></td>
  154.       </tr>
  155.     </tbody>
  156.   </table>
  157.   <h3 id="methods">Methods
  158.   </h3>
  159.   <span class="small pull-right mobile-hide">
  160.     <span class="divider">|</span>
  161.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_Stores_GeneratedExtension_Generated__1_IPA_Config_Config_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.GeneratedExtension.Generated%60%601(IPA.Config.Config%2CSystem.Boolean)%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>
  162.   </span>
  163.   <span class="small pull-right mobile-hide">
  164.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/a2ab33cc30a9c138f1aa39f73a6095b740f38a68/IPA.Loader/Config/Stores/GeneratedStore.cs/#L82">View Source</a>
  165.   </span>
  166.   <a id="IPA_Config_Stores_GeneratedExtension_Generated_" data-uid="IPA.Config.Stores.GeneratedExtension.Generated*"></a>
  167.   <h4 id="IPA_Config_Stores_GeneratedExtension_Generated__1_IPA_Config_Config_System_Boolean_" data-uid="IPA.Config.Stores.GeneratedExtension.Generated``1(IPA.Config.Config,System.Boolean)">Generated&lt;T&gt;(Config, Boolean)</h4>
  168.   <div class="markdown level1 summary"><p>Creates a generated <a class="xref" href="IPA.Config.IConfigStore.html">IConfigStore</a> of type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>, registers it to
  169. the <a class="xref" href="IPA.Config.Config.html">Config</a> object, and returns it. This also forces a synchronous config load via
  170. <a class="xref" href="IPA.Config.Config.html#IPA_Config_Config_LoadSync">LoadSync()</a> if <code data-dev-comment-type="paramref" class="paramref">loadSync</code> is <span class="xref">true</span>.</p>
  171. </div>
  172.   <div class="markdown level1 conceptual"></div>
  173.   <h5 class="decalaration">Declaration</h5>
  174.   <div class="codewrapper">
  175.     <pre><code class="lang-csharp hljs">public static T Generated&lt;T&gt;(this Config cfg, bool loadSync = true)
  176.     where T : class</code></pre>
  177.   </div>
  178.   <h5 class="parameters">Parameters</h5>
  179.   <table class="table table-bordered table-striped table-condensed">
  180.     <thead>
  181.       <tr>
  182.         <th>Type</th>
  183.         <th>Name</th>
  184.         <th>Description</th>
  185.       </tr>
  186.     </thead>
  187.     <tbody>
  188.       <tr>
  189.         <td><a class="xref" href="IPA.Config.Config.html">Config</a></td>
  190.         <td><span class="parametername">cfg</span></td>
  191.         <td><p>the <a class="xref" href="IPA.Config.Config.html">Config</a> to register to</p>
  192. </td>
  193.       </tr>
  194.       <tr>
  195.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  196.         <td><span class="parametername">loadSync</span></td>
  197.         <td><p>whether to synchronously load the content, or trigger an async load</p>
  198. </td>
  199.       </tr>
  200.     </tbody>
  201.   </table>
  202.   <h5 class="returns">Returns</h5>
  203.   <table class="table table-bordered table-striped table-condensed">
  204.     <thead>
  205.       <tr>
  206.         <th>Type</th>
  207.         <th>Description</th>
  208.       </tr>
  209.     </thead>
  210.     <tbody>
  211.       <tr>
  212.         <td><span class="xref">T</span></td>
  213.         <td><p>a generated instance of <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> as a special <a class="xref" href="IPA.Config.IConfigStore.html">IConfigStore</a></p>
  214. </td>
  215.       </tr>
  216.     </tbody>
  217.   </table>
  218.   <h5 class="typeParameters">Type Parameters</h5>
  219.   <table class="table table-bordered table-striped table-condensed">
  220.     <thead>
  221.       <tr>
  222.         <th>Name</th>
  223.         <th>Description</th>
  224.       </tr>
  225.     </thead>
  226.     <tbody>
  227.       <tr>
  228.         <td><span class="parametername">T</span></td>
  229.         <td><p>the type to wrap</p>
  230. </td>
  231.       </tr>
  232.     </tbody>
  233.   </table>
  234.   <h5 id="IPA_Config_Stores_GeneratedExtension_Generated__1_IPA_Config_Config_System_Boolean__remarks">Remarks</h5>
  235.   <div class="markdown level1 remarks"><p>
  236. <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> must be a public non-<span class="xref">sealed</span> class.
  237. It can also be internal, but in that case, then your assembly must have the following attribute
  238. to allow the generated code to reference it.
  239. <pre><code>[assembly: InternalsVisibleTo(IPA.Config.Stores.GeneratedExtension.AssemblyVisibilityTarget)]</code></pre>
  240. </p>
  241. <p>
  242. Only fields and properties that are public or protected will be considered, and only properties
  243. where both the getter and setter are public or protected are considered. Any fields or properties
  244. with an <a class="xref" href="IPA.Config.Stores.Attributes.IgnoreAttribute.html">IgnoreAttribute</a> applied to them are also ignored. Having properties be <span class="xref">virtual</span> is not strictly
  245. necessary, however it allows the generated type to keep track of changes and lock around them so that the config will auto-save.
  246. </p>
  247. <p>
  248. All of the attributes in the <a class="xref" href="IPA.Config.Stores.Attributes.html">IPA.Config.Stores.Attributes</a> namespace are handled as described by them.
  249. </p>
  250. <p>
  251. If the <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> declares a public or protected, <span class="xref">virtual</span>
  252. method <code>Changed()</code>, then that method may be called to artificially signal to the runtime that the content of the object 
  253. has changed. That method will also be called after the write locks are released when a property is set anywhere in the owning
  254. tree. This will only be called on the outermost generated object of the config structure, even if the change being signaled
  255. is somewhere deep into the tree. TODO: is this a good idea?
  256. </p>
  257. <p>
  258. Similarly, <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> can declare a public or protected, <span class="xref">virtual</span> 
  259. method <code>OnReload()</code>, which will be called on the filesystem reader thread after the object has been repopulated with new data 
  260. values. It will be called <em>after</em> the write lock for this object is released. This will only be called on the outermost generated
  261. object of the config structure.
  262. </p>
  263. <p>
  264. TODO: describe details of generated stores
  265. </p>
  266. </div>
  267. </article>
  268.           </div>
  269.           
  270.           <div class="hidden-sm col-md-2" role="complementary">
  271.             <div class="sideaffix">
  272.               <div class="contribution">
  273.                 <ul class="nav">
  274.                   <li>
  275.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_Stores_GeneratedExtension.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.GeneratedExtension%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>
  276.                   </li>
  277.                   <li>
  278.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/a2ab33cc30a9c138f1aa39f73a6095b740f38a68/IPA.Loader/Config/Stores/GeneratedStore.cs/#L31" class="contribution-link">View Source</a>
  279.                   </li>
  280.                 </ul>
  281.               </div>
  282.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  283.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  284.               </nav>
  285.             </div>
  286.           </div>
  287.         </div>
  288.       </div>
  289.       
  290.       <footer>
  291.         <div class="grad-bottom"></div>
  292.         <div class="footer">
  293.           <div class="container">
  294.             <span class="pull-right">
  295.               <a href="#top">Back to top</a>
  296.             </span>
  297.             
  298.             <span>Generated by <strong>DocFX</strong></span>
  299.           </div>
  300.         </div>
  301.       </footer>
  302.     </div>
  303.     
  304.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  305.     <script type="text/javascript" src="../styles/docfx.js"></script>
  306.     <script type="text/javascript" src="../styles/main.js"></script>
  307.   </body>
  308. </html>