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.
206 Commits
9 Branches
147 MiB
Tree: 6e58a2be21
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '6e58a2be21'
${ noResults }
BeatSaber-IPA-Reloaded/api/IPA.Config.Stores.IValueCon...

317 lines
16 KiB
Raw Normal View History

Generated Docs --
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
4 years ago
Generated Docs --
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
4 years ago
Generated Docs --
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
4 years ago
Generated Docs --
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
4 years ago
Generated Docs --
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 IValueConverter
  9.    </title>
  10.     <meta name="viewport" content="width=device-width">
  11.     <meta name="title" content="Interface IValueConverter
  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 rel="stylesheet" href="../styles/fix.css">
  20.     <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
  21.     <meta property="docfx:navrel" content="../toc.html">
  22.     <meta property="docfx:tocrel" content="toc.html">
  23.     
  24.     <meta property="docfx:rel" content="../">
  25.     <meta property="docfx:newtab" content="true">
  26.   </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
  27.     <div id="wrapper">
  28.       <header>
  29.         
  30.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  31.           <div class="container">
  32.             <div class="navbar-header">
  33.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  34.                 <span class="sr-only">Toggle navigation</span>
  35.                 <span class="icon-bar"></span>
  36.                 <span class="icon-bar"></span>
  37.                 <span class="icon-bar"></span>
  38.               </button>
  39.               
  40.               <a class="navbar-brand" href="../index.html">
  41.                 <img id="logo" class="svg" src="../logo.svg" alt="">
  42.               </a>
  43.             </div>
  44.             <div class="collapse navbar-collapse" id="navbar">
  45.               <form class="navbar-form navbar-right" role="search" id="search">
  46.                 <div class="form-group">
  47.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  48.                 </div>
  49.               </form>
  50.             </div>
  51.           </div>
  52.         </nav>
  53.         
  54.         <div class="subnav navbar navbar-default">
  55.           <div class="container hide-when-search" id="breadcrumb">
  56.             <ul class="breadcrumb">
  57.               <li></li>
  58.             </ul>
  59.           </div>
  60.         </div>
  61.       </header>
  62.       <div class="container body-content">
  63.         
  64.         <div id="search-results">
  65.           <div class="search-list"></div>
  66.           <div class="sr-items">
  67.             <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  68.           </div>
  69.           <ul id="pagination"></ul>
  70.         </div>
  71.       </div>
  72.       <div role="main" class="container body-content hide-when-search">
  73.         
  74.         <div class="sidenav hide-when-search">
  75.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  76.           <div class="sidetoggle collapse" id="sidetoggle">
  77.             <div id="sidetoc"></div>
  78.           </div>
  79.         </div>
  80.         <div class="article row grid-right">
  81.           <div class="col-md-10">
  82.             <article class="content wrap" id="_content" data-uid="IPA.Config.Stores.IValueConverter">
  83.   
  84.   
  85.   <h1 id="IPA_Config_Stores_IValueConverter" data-uid="IPA.Config.Stores.IValueConverter" class="text-break">Interface IValueConverter
  86.   </h1>
  87.   <div class="markdown level0 summary"><p>The base interface for a value converter for use by objects generated by
  88. <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>
  89. </div>
  90.   <div class="markdown level0 conceptual"></div>
  91.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.html">IPA.Config.Stores</a></h6>
  92.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  93.   <h5 id="IPA_Config_Stores_IValueConverter_syntax">Syntax</h5>
  94.   <div class="codewrapper">
  95.     <pre><code class="lang-csharp hljs">public interface IValueConverter</code></pre>
  96.   </div>
  97.   <h5 id="IPA_Config_Stores_IValueConverter_remarks"><strong>Remarks</strong></h5>
  98.   <div class="markdown level0 remarks"><p>
  99. The object returned from <a class="xref" href="IPA.Config.Stores.IValueConverter.html#IPA_Config_Stores_IValueConverter_FromValue_IPA_Config_Data_Value_System_Object_">FromValue(Value, Object)</a>, if fed into <a class="xref" href="IPA.Config.Stores.IValueConverter.html#IPA_Config_Stores_IValueConverter_ToValue_System_Object_System_Object_">ToValue(Object, Object)</a>,
  100. should return equivalent <a class="xref" href="IPA.Config.Data.Value.html">Value</a> structures. Similarly, if the result of <a class="xref" href="IPA.Config.Stores.IValueConverter.html#IPA_Config_Stores_IValueConverter_ToValue_System_Object_System_Object_">ToValue(Object, Object)</a>
  101. is fed into <a class="xref" href="IPA.Config.Stores.IValueConverter.html#IPA_Config_Stores_IValueConverter_FromValue_IPA_Config_Data_Value_System_Object_">FromValue(Value, Object)</a>, the resulting object should be equivalent to the one passed to 
  102. <a class="xref" href="IPA.Config.Stores.IValueConverter.html#IPA_Config_Stores_IValueConverter_ToValue_System_Object_System_Object_">ToValue(Object, Object)</a>.
  103. </p>
  104. <p>
  105. The <code>parent</code> parameter to <a class="xref" href="IPA.Config.Stores.IValueConverter.html#IPA_Config_Stores_IValueConverter_ToValue_System_Object_System_Object_">ToValue(Object, Object)</a> and <a class="xref" href="IPA.Config.Stores.IValueConverter.html#IPA_Config_Stores_IValueConverter_FromValue_IPA_Config_Data_Value_System_Object_">FromValue(Value, Object)</a> should
  106. be (ideally) the the top of the serialization tree, or some other generated object in that tree, rather than some arbitrary
  107. object in the middle that is not managed by the generatd config system.
  108. </p>
  109. <p>
  110. Converters do <em>not</em> need to perform null checks, as the serializer and deserializer will do that automatically.
  111. </p>
  112. </div>
  113.   <h3 id="properties">Properties
  114.   </h3>
  115.   <span class="small pull-right mobile-hide">
  116.     <span class="divider">|</span>
  117.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_IValueConverter_Type.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.IValueConverter.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>
  118.   </span>
  119.   <span class="small pull-right mobile-hide">
  120.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/ValueConverter.cs/#L45">View Source</a>
  121.   </span>
  122.   <a id="IPA_Config_Stores_IValueConverter_Type_" data-uid="IPA.Config.Stores.IValueConverter.Type*"></a>
  123.   <h4 id="IPA_Config_Stores_IValueConverter_Type" data-uid="IPA.Config.Stores.IValueConverter.Type">Type</h4>
  124.   <div class="markdown level1 summary"><p>Gets the type that this <a class="xref" href="IPA.Config.Stores.IValueConverter.html">IValueConverter</a> handles.</p>
  125. </div>
  126.   <div class="markdown level1 conceptual"></div>
  127.   <h5 class="decalaration">Declaration</h5>
  128.   <div class="codewrapper">
  129.     <pre><code class="lang-csharp hljs">Type Type { get; }</code></pre>
  130.   </div>
  131.   <h5 class="propertyValue">Property Value</h5>
  132.   <table class="table table-bordered table-striped table-condensed">
  133.     <thead>
  134.       <tr>
  135.         <th>Type</th>
  136.         <th>Description</th>
  137.       </tr>
  138.     </thead>
  139.     <tbody>
  140.       <tr>
  141.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>
  142.         <td></td>
  143.       </tr>
  144.     </tbody>
  145.   </table>
  146.   <h3 id="methods">Methods
  147.   </h3>
  148.   <span class="small pull-right mobile-hide">
  149.     <span class="divider">|</span>
  150.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_IValueConverter_FromValue_IPA_Config_Data_Value_System_Object_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.IValueConverter.FromValue(IPA.Config.Data.Value%2CSystem.Object)%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>
  151.   </span>
  152.   <span class="small pull-right mobile-hide">
  153.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/ValueConverter.cs/#L41">View Source</a>
  154.   </span>
  155.   <a id="IPA_Config_Stores_IValueConverter_FromValue_" data-uid="IPA.Config.Stores.IValueConverter.FromValue*"></a>
  156.   <h4 id="IPA_Config_Stores_IValueConverter_FromValue_IPA_Config_Data_Value_System_Object_" data-uid="IPA.Config.Stores.IValueConverter.FromValue(IPA.Config.Data.Value,System.Object)">FromValue(Value, Object)</h4>
  157.   <div class="markdown level1 summary"><p>Converts the given <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to the object type handled by this converter.</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">object FromValue(Value value, object parent)</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="IPA.Config.Data.Value.html">Value</a></td>
  176.         <td><span class="parametername">value</span></td>
  177.         <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to deserialize</p>
  178. </td>
  179.       </tr>
  180.       <tr>
  181.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>
  182.         <td><span class="parametername">parent</span></td>
  183.         <td><p>the object that will own the result</p>
  184. </td>
  185.       </tr>
  186.     </tbody>
  187.   </table>
  188.   <h5 class="returns">Returns</h5>
  189.   <table class="table table-bordered table-striped table-condensed">
  190.     <thead>
  191.       <tr>
  192.         <th>Type</th>
  193.         <th>Description</th>
  194.       </tr>
  195.     </thead>
  196.     <tbody>
  197.       <tr>
  198.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>
  199.         <td><p>the deserialized object</p>
  200. </td>
  201.       </tr>
  202.     </tbody>
  203.   </table>
  204.   <span class="small pull-right mobile-hide">
  205.     <span class="divider">|</span>
  206.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_IValueConverter_ToValue_System_Object_System_Object_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.IValueConverter.ToValue(System.Object%2CSystem.Object)%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>
  207.   </span>
  208.   <span class="small pull-right mobile-hide">
  209.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/ValueConverter.cs/#L34">View Source</a>
  210.   </span>
  211.   <a id="IPA_Config_Stores_IValueConverter_ToValue_" data-uid="IPA.Config.Stores.IValueConverter.ToValue*"></a>
  212.   <h4 id="IPA_Config_Stores_IValueConverter_ToValue_System_Object_System_Object_" data-uid="IPA.Config.Stores.IValueConverter.ToValue(System.Object,System.Object)">ToValue(Object, Object)</h4>
  213.   <div class="markdown level1 summary"><p>Converts the given object to a <a class="xref" href="IPA.Config.Data.Value.html">Value</a>.</p>
  214. </div>
  215.   <div class="markdown level1 conceptual"></div>
  216.   <h5 class="decalaration">Declaration</h5>
  217.   <div class="codewrapper">
  218.     <pre><code class="lang-csharp hljs">Value ToValue(object obj, object parent)</code></pre>
  219.   </div>
  220.   <h5 class="parameters">Parameters</h5>
  221.   <table class="table table-bordered table-striped table-condensed">
  222.     <thead>
  223.       <tr>
  224.         <th>Type</th>
  225.         <th>Name</th>
  226.         <th>Description</th>
  227.       </tr>
  228.     </thead>
  229.     <tbody>
  230.       <tr>
  231.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>
  232.         <td><span class="parametername">obj</span></td>
  233.         <td><p>the object to convert</p>
  234. </td>
  235.       </tr>
  236.       <tr>
  237.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>
  238.         <td><span class="parametername">parent</span></td>
  239.         <td><p>the owning object of <code data-dev-comment-type="paramref" class="paramref">obj</code></p>
  240. </td>
  241.       </tr>
  242.     </tbody>
  243.   </table>
  244.   <h5 class="returns">Returns</h5>
  245.   <table class="table table-bordered table-striped table-condensed">
  246.     <thead>
  247.       <tr>
  248.         <th>Type</th>
  249.         <th>Description</th>
  250.       </tr>
  251.     </thead>
  252.     <tbody>
  253.       <tr>
  254.         <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  255.         <td><p>a representation of <code data-dev-comment-type="paramref" class="paramref">obj</code> as a <a class="xref" href="IPA.Config.Data.Value.html">Value</a> structure</p>
  256. </td>
  257.       </tr>
  258.     </tbody>
  259.   </table>
  260.   <h3 id="extensionmethods">Extension Methods</h3>
  261.   <div>
  262.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;T, U&gt;(T, String, U)</a>
  263.   </div>
  264.   <div>
  265.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, T&gt;(T, String)</a>
  266.   </div>
  267.   <div>
  268.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;T, U&gt;(T, String, U)</a>
  269.   </div>
  270.   <div>
  271.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, T&gt;(T, String)</a>
  272.   </div>
  273.   <div>
  274.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, T&gt;(T, String, Object[])</a>
  275.   </div>
  276. </article>
  277.           </div>
  278.           
  279.           <div class="hidden-sm col-md-2" role="complementary">
  280.             <div class="sideaffix">
  281.               <div class="contribution">
  282.                 <ul class="nav">
  283.                   <li>
  284.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_IValueConverter.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.IValueConverter%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>
  285.                   </li>
  286.                   <li>
  287.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/e538ecf3d7cc78de8933918464f39f35107a8bc2/IPA.Loader/Config/Stores/ValueConverter.cs/#L26" class="contribution-link">View Source</a>
  288.                   </li>
  289.                 </ul>
  290.               </div>
  291.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  292.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  293.               </nav>
  294.             </div>
  295.           </div>
  296.         </div>
  297.       </div>
  298.       
  299.       <footer>
  300.         <div class="grad-bottom"></div>
  301.         <div class="footer">
  302.           <div class="container">
  303.             <span class="pull-right">
  304.               <a href="#top">Back to top</a>
  305.             </span>
  306.             
  307.             <span>Generated by <strong>DocFX</strong></span>
  308.           </div>
  309.         </div>
  310.       </footer>
  311.     </div>
  312.     
  313.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  314.     <script type="text/javascript" src="../styles/docfx.js"></script>
  315.     <script type="text/javascript" src="../styles/main.js"></script>
  316.   </body>
  317. </html>