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.

247 lines
12 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class Converter
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Converter
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link rel="stylesheet" href="../styles/fix.css">
  18. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../">
  22. <meta property="docfx:newtab" content="true">
  23. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  24. <div id="wrapper">
  25. <header>
  26. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  30. <span class="sr-only">Toggle navigation</span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. <a class="navbar-brand" href="../index.html">
  36. <img id="logo" class="svg" src="../logo.svg" alt="">
  37. </a>
  38. </div>
  39. <div class="collapse navbar-collapse" id="navbar">
  40. <form class="navbar-form navbar-right" role="search" id="search">
  41. <div class="form-group">
  42. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  43. </div>
  44. </form>
  45. </div>
  46. </div>
  47. </nav>
  48. <div class="subnav navbar navbar-default">
  49. <div class="container hide-when-search" id="breadcrumb">
  50. <ul class="breadcrumb">
  51. <li></li>
  52. </ul>
  53. </div>
  54. </div>
  55. </header>
  56. <div class="container body-content">
  57. <div id="search-results">
  58. <div class="search-list">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  63. </div>
  64. </div>
  65. <div role="main" class="container body-content hide-when-search">
  66. <div class="sidenav hide-when-search">
  67. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  68. <div class="sidetoggle collapse" id="sidetoggle">
  69. <div id="sidetoc"></div>
  70. </div>
  71. </div>
  72. <div class="article row grid-right">
  73. <div class="col-md-10">
  74. <article class="content wrap" id="_content" data-uid="IPA.Config.Stores.Converters.Converter">
  75. <h1 id="IPA_Config_Stores_Converters_Converter" data-uid="IPA.Config.Stores.Converters.Converter" class="text-break">Class Converter
  76. </h1>
  77. <div class="markdown level0 summary"><p>Provides utility functions for custom converters.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><span class="xref">Converter</span></div>
  84. </div>
  85. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.Converters.html">IPA.Config.Stores.Converters</a></h6>
  86. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  87. <h5 id="IPA_Config_Stores_Converters_Converter_syntax">Syntax</h5>
  88. <div class="codewrapper">
  89. <pre><code class="lang-csharp hljs">public static class Converter : object</code></pre>
  90. </div>
  91. <h3 id="methods">Methods
  92. </h3>
  93. <span class="small pull-right mobile-hide">
  94. <span class="divider">|</span>
  95. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_Converter_FloatValue_IPA_Config_Data_Value_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.Converter.FloatValue(IPA.Config.Data.Value)%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>
  96. </span>
  97. <span class="small pull-right mobile-hide">
  98. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Stores/Converters.cs/#L36">View Source</a>
  99. </span>
  100. <a id="IPA_Config_Stores_Converters_Converter_FloatValue_" data-uid="IPA.Config.Stores.Converters.Converter.FloatValue*"></a>
  101. <h4 id="IPA_Config_Stores_Converters_Converter_FloatValue_IPA_Config_Data_Value_" data-uid="IPA.Config.Stores.Converters.Converter.FloatValue(IPA.Config.Data.Value)">FloatValue(Value)</h4>
  102. <div class="markdown level1 summary"><p>Gets the floaing point value of a <a class="xref" href="IPA.Config.Data.Value.html">Value</a>, coercing an <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> if necessary,
  103. or <span class="xref">null</span> if <code data-dev-comment-type="paramref" class="paramref">val</code> is not an <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> or <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>.</p>
  104. </div>
  105. <div class="markdown level1 conceptual"></div>
  106. <h5 class="decalaration">Declaration</h5>
  107. <div class="codewrapper">
  108. <pre><code class="lang-csharp hljs">public static decimal? FloatValue(Value val)</code></pre>
  109. </div>
  110. <h5 class="parameters">Parameters</h5>
  111. <table class="table table-bordered table-striped table-condensed">
  112. <thead>
  113. <tr>
  114. <th>Type</th>
  115. <th>Name</th>
  116. <th>Description</th>
  117. </tr>
  118. </thead>
  119. <tbody>
  120. <tr>
  121. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  122. <td><span class="parametername">val</span></td>
  123. <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to get the floaing point value of</p>
  124. </td>
  125. </tr>
  126. </tbody>
  127. </table>
  128. <h5 class="returns">Returns</h5>
  129. <table class="table table-bordered table-striped table-condensed">
  130. <thead>
  131. <tr>
  132. <th>Type</th>
  133. <th>Description</th>
  134. </tr>
  135. </thead>
  136. <tbody>
  137. <tr>
  138. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.decimal">Decimal</a>&gt;</td>
  139. <td><p>the floaing point value of <code data-dev-comment-type="paramref" class="paramref">val</code>, or <span class="xref">null</span></p>
  140. </td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <span class="small pull-right mobile-hide">
  145. <span class="divider">|</span>
  146. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_Converter_IntValue_IPA_Config_Data_Value_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.Converter.IntValue(IPA.Config.Data.Value)%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>
  147. </span>
  148. <span class="small pull-right mobile-hide">
  149. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Stores/Converters.cs/#L26">View Source</a>
  150. </span>
  151. <a id="IPA_Config_Stores_Converters_Converter_IntValue_" data-uid="IPA.Config.Stores.Converters.Converter.IntValue*"></a>
  152. <h4 id="IPA_Config_Stores_Converters_Converter_IntValue_IPA_Config_Data_Value_" data-uid="IPA.Config.Stores.Converters.Converter.IntValue(IPA.Config.Data.Value)">IntValue(Value)</h4>
  153. <div class="markdown level1 summary"><p>Gets the integral value of a <a class="xref" href="IPA.Config.Data.Value.html">Value</a>, coercing a <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a> if necessary,
  154. or <span class="xref">null</span> if <code data-dev-comment-type="paramref" class="paramref">val</code> is not an <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> or <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>.</p>
  155. </div>
  156. <div class="markdown level1 conceptual"></div>
  157. <h5 class="decalaration">Declaration</h5>
  158. <div class="codewrapper">
  159. <pre><code class="lang-csharp hljs">public static long? IntValue(Value val)</code></pre>
  160. </div>
  161. <h5 class="parameters">Parameters</h5>
  162. <table class="table table-bordered table-striped table-condensed">
  163. <thead>
  164. <tr>
  165. <th>Type</th>
  166. <th>Name</th>
  167. <th>Description</th>
  168. </tr>
  169. </thead>
  170. <tbody>
  171. <tr>
  172. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  173. <td><span class="parametername">val</span></td>
  174. <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to get the integral value of</p>
  175. </td>
  176. </tr>
  177. </tbody>
  178. </table>
  179. <h5 class="returns">Returns</h5>
  180. <table class="table table-bordered table-striped table-condensed">
  181. <thead>
  182. <tr>
  183. <th>Type</th>
  184. <th>Description</th>
  185. </tr>
  186. </thead>
  187. <tbody>
  188. <tr>
  189. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int64">Int64</a>&gt;</td>
  190. <td><p>the integral value of <code data-dev-comment-type="paramref" class="paramref">val</code>, or <span class="xref">null</span></p>
  191. </td>
  192. </tr>
  193. </tbody>
  194. </table>
  195. </article>
  196. </div>
  197. <div class="hidden-sm col-md-2" role="complementary">
  198. <div class="sideaffix">
  199. <div class="contribution">
  200. <ul class="nav">
  201. <li>
  202. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_Converter.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.Converter%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>
  203. </li>
  204. <li>
  205. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Stores/Converters.cs/#L18" class="contribution-link">View Source</a>
  206. </li>
  207. </ul>
  208. </div>
  209. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  210. <h5>In This Article</h5>
  211. <div></div>
  212. </nav>
  213. </div>
  214. </div>
  215. </div>
  216. </div>
  217. <footer>
  218. <div class="grad-bottom"></div>
  219. <div class="footer">
  220. <div class="container">
  221. <span class="pull-right">
  222. <a href="#top">Back to top</a>
  223. </span>
  224. <span>Generated by <strong>DocFX</strong></span>
  225. </div>
  226. </div>
  227. </footer>
  228. </div>
  229. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  230. <script type="text/javascript" src="../styles/docfx.js"></script>
  231. <script type="text/javascript" src="../styles/main.js"></script>
  232. </body>
  233. </html>