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 GeneratedStore   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Class GeneratedStore   ">    <meta name="generator" content="docfx 2.48.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 rel="stylesheet" href="../styles/fix.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.Stores.GeneratedStore">      <h1 id="IPA_Config_Stores_GeneratedStore" data-uid="IPA.Config.Stores.GeneratedStore" class="text-break">Class GeneratedStore  </h1>  <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 generatedconfig stores.</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">GeneratedStore</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.Stores.html">IPA.Config.Stores</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Config_Stores_GeneratedStore_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static class GeneratedStore</code></pre>  </div>  <h3 id="fields">Fields  </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_Stores_GeneratedStore_AssemblyVisibilityTarget.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.GeneratedStore.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/GeneratedStoreImpl.cs/#L37">View Source</a>  </span>  <h4 id="IPA_Config_Stores_GeneratedStore_AssemblyVisibilityTarget" data-uid="IPA.Config.Stores.GeneratedStore.AssemblyVisibilityTarget">AssemblyVisibilityTarget</h4>  <div class="markdown level1 summary"><p>The name of the assembly that internals must be visible to to allow internal protection.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public const string AssemblyVisibilityTarget = &quot;IPA.Config.Generated&quot;</code></pre>  </div>  <h5 class="fieldValue">Field Value</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="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>        <td></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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_GeneratedStore_Create__1.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.GeneratedStore.Create%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/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/GeneratedStoreImpl.cs/#L119">View Source</a>  </span>  <a id="IPA_Config_Stores_GeneratedStore_Create_" data-uid="IPA.Config.Stores.GeneratedStore.Create*"></a>  <h4 id="IPA_Config_Stores_GeneratedStore_Create__1" data-uid="IPA.Config.Stores.GeneratedStore.Create``1">Create&lt;T&gt;()</h4>  <div class="markdown level1 summary"><p>Creates a generated store outside of the context of the config system.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static T Create&lt;T&gt;()    where T : class</code></pre>  </div>  <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>a generated instance of <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> implementing functionality described by <a class="xref" href="IPA.Config.Stores.GeneratedStore.html#IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_">Generated&lt;T&gt;(Config, Boolean)</a></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 to wrap</p></td>      </tr>    </tbody>  </table>  <h5 id="IPA_Config_Stores_GeneratedStore_Create__1_remarks">Remarks</h5>  <div class="markdown level1 remarks"><p>See <a class="xref" href="IPA.Config.Stores.GeneratedStore.html#IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_">Generated&lt;T&gt;(Config, Boolean)</a> for more information about how it behaves.</p></div>  <h5 id="IPA_Config_Stores_GeneratedStore_Create__1_seealso">See Also</h5>  <div class="seealso">      <div><a class="xref" href="IPA.Config.Stores.GeneratedStore.html#IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_">Generated&lt;T&gt;(Config, Boolean)</a></div>  </div>  <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_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.GeneratedStore.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/GeneratedStoreImpl.cs/#L98">View Source</a>  </span>  <a id="IPA_Config_Stores_GeneratedStore_Generated_" data-uid="IPA.Config.Stores.GeneratedStore.Generated*"></a>  <h4 id="IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_" data-uid="IPA.Config.Stores.GeneratedStore.Generated``1(IPA.Config.Config,System.Boolean)">Generated&lt;T&gt;(Config, Boolean)</h4>  <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 tothe <a class="xref" href="IPA.Config.Config.html">Config</a> object, and returns it. This also forces a synchronous config load via<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></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static T Generated&lt;T&gt;(this Config cfg, bool loadSync = true)    where T : class</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.Config.html">Config</a></td>        <td><span class="parametername">cfg</span></td>        <td><p>the <a class="xref" href="IPA.Config.Config.html">Config</a> to register to</p></td>      </tr>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>        <td><span class="parametername">loadSync</span></td>        <td><p>whether to synchronously load the content, or trigger an async load</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>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></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 to wrap</p></td>      </tr>    </tbody>  </table>  <h5 id="IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean__remarks">Remarks</h5>  <div class="markdown level1 remarks"><p><code data-dev-comment-type="typeparamref" class="typeparamref">T</code> must be a public non-<span class="xref">sealed</span> class.It can also be internal, but in that case, then your assembly must have the following attributeto allow the generated code to reference it.<pre><code>[assembly: InternalsVisibleTo(IPA.Config.Stores.GeneratedStore.AssemblyVisibilityTarget)]</code></pre></p><p>Only fields and properties that are public or protected will be considered, and only propertieswhere both the getter and setter are public or protected are considered. Any fields or propertieswith 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 strictlynecessary, however it allows the generated type to keep track of changes and lock around them so that the config will auto-save.</p><p>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.</p><p>If the <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> declares a public or protected, <span class="xref">virtual</span>method <code>Changed()</code>, then that method may be called to artificially signal to the runtime that the content of the object has changed. That method will also be called after the write locks are released when a property is set anywhere in the owningtree. This will only be called on the outermost generated object of the config structure, even if the change being signaledis somewhere deep into the tree. TODO: is this a good idea?</p><p>Similarly, <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> can declare a public or protected, <span class="xref">virtual</span> method <code>OnReload()</code>, which will be called on the filesystem reader thread after the object has been repopulated with new data values. It will be called <em>after</em> the write lock for this object is released. This will only be called on the outermost generatedobject of the config structure.</p><p>Similarly, <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> can declare a public or protected, <span class="xref">virtual</span> method <code>CopyFrom(ConfigType)</code> (the first parameter is the type it is defined on), which may be called to copy the properties fromanother object of its type easily, and more importantly, as only one change. Its body will be executed after the values have been copied.</p><p>Similarly, <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> can declare a public or protected, <span class="xref">virtual</span> method <code>ChangeTransaction()</code> returning <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a>, which may be called to get an object representing a transactionalchange. This may be used to change a lot of properties at once without triggering a save multiple times. Ideally, this is used in a<span class="xref">langword_csharp_using</span> block or declaration. The <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a> returned from your implementation will have its<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable.dispose#System_IDisposable_Dispose">Dispose()</a> called <em>after</em> <code>Changed()</code> is called, but <em>before</em> the write lock is released.Unless you have a very good reason to use the nested <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a>, avoid it.</p><p>If <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> is marked with <a class="xref" href="IPA.Config.Stores.Attributes.NotifyPropertyChangesAttribute.html">NotifyPropertyChangesAttribute</a>, the resulting object will implement<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.componentmodel.inotifypropertychanged">INotifyPropertyChanged</a>. Similarly, if <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> implements <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.componentmodel.inotifypropertychanged">INotifyPropertyChanged</a>,the resulting object will implement it and notify it too.</p></div></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_Stores_GeneratedStore.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.GeneratedStore%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/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/GeneratedStoreImpl.cs/#L32" 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>