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.

270 lines
13 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.56.2.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"></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination"></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. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  92. </div>
  93. <div>
  94. <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>
  95. </div>
  96. <div>
  97. <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>
  98. </div>
  99. <div>
  100. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.Converters.html">IPA.Config.Stores.Converters</a></h6>
  110. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  111. <h5 id="IPA_Config_Stores_Converters_Converter_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public static class Converter</code></pre>
  114. </div>
  115. <h3 id="methods">Methods
  116. </h3>
  117. <span class="small pull-right mobile-hide">
  118. <span class="divider">|</span>
  119. <a href="https://github.com/bsmg/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>
  120. </span>
  121. <span class="small pull-right mobile-hide">
  122. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/ac379a44892b8b04c86319bc9144b39d294e40b1/IPA.Loader/Config/Stores/Converters.cs/#L35">View Source</a>
  123. </span>
  124. <a id="IPA_Config_Stores_Converters_Converter_FloatValue_" data-uid="IPA.Config.Stores.Converters.Converter.FloatValue*"></a>
  125. <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>
  126. <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,
  127. 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>
  128. </div>
  129. <div class="markdown level1 conceptual"></div>
  130. <h5 class="decalaration">Declaration</h5>
  131. <div class="codewrapper">
  132. <pre><code class="lang-csharp hljs">public static decimal? FloatValue(Value val)</code></pre>
  133. </div>
  134. <h5 class="parameters">Parameters</h5>
  135. <table class="table table-bordered table-striped table-condensed">
  136. <thead>
  137. <tr>
  138. <th>Type</th>
  139. <th>Name</th>
  140. <th>Description</th>
  141. </tr>
  142. </thead>
  143. <tbody>
  144. <tr>
  145. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  146. <td><span class="parametername">val</span></td>
  147. <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to get the floaing point value of</p>
  148. </td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. <h5 class="returns">Returns</h5>
  153. <table class="table table-bordered table-striped table-condensed">
  154. <thead>
  155. <tr>
  156. <th>Type</th>
  157. <th>Description</th>
  158. </tr>
  159. </thead>
  160. <tbody>
  161. <tr>
  162. <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>
  163. <td><p>the floaing point value of <code data-dev-comment-type="paramref" class="paramref">val</code>, or <span class="xref">null</span></p>
  164. </td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. <span class="small pull-right mobile-hide">
  169. <span class="divider">|</span>
  170. <a href="https://github.com/bsmg/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>
  171. </span>
  172. <span class="small pull-right mobile-hide">
  173. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/ac379a44892b8b04c86319bc9144b39d294e40b1/IPA.Loader/Config/Stores/Converters.cs/#L25">View Source</a>
  174. </span>
  175. <a id="IPA_Config_Stores_Converters_Converter_IntValue_" data-uid="IPA.Config.Stores.Converters.Converter.IntValue*"></a>
  176. <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>
  177. <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,
  178. 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>
  179. </div>
  180. <div class="markdown level1 conceptual"></div>
  181. <h5 class="decalaration">Declaration</h5>
  182. <div class="codewrapper">
  183. <pre><code class="lang-csharp hljs">public static long? IntValue(Value val)</code></pre>
  184. </div>
  185. <h5 class="parameters">Parameters</h5>
  186. <table class="table table-bordered table-striped table-condensed">
  187. <thead>
  188. <tr>
  189. <th>Type</th>
  190. <th>Name</th>
  191. <th>Description</th>
  192. </tr>
  193. </thead>
  194. <tbody>
  195. <tr>
  196. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  197. <td><span class="parametername">val</span></td>
  198. <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to get the integral value of</p>
  199. </td>
  200. </tr>
  201. </tbody>
  202. </table>
  203. <h5 class="returns">Returns</h5>
  204. <table class="table table-bordered table-striped table-condensed">
  205. <thead>
  206. <tr>
  207. <th>Type</th>
  208. <th>Description</th>
  209. </tr>
  210. </thead>
  211. <tbody>
  212. <tr>
  213. <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>
  214. <td><p>the integral value of <code data-dev-comment-type="paramref" class="paramref">val</code>, or <span class="xref">null</span></p>
  215. </td>
  216. </tr>
  217. </tbody>
  218. </table>
  219. </article>
  220. </div>
  221. <div class="hidden-sm col-md-2" role="complementary">
  222. <div class="sideaffix">
  223. <div class="contribution">
  224. <ul class="nav">
  225. <li>
  226. <a href="https://github.com/bsmg/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>
  227. </li>
  228. <li>
  229. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/ac379a44892b8b04c86319bc9144b39d294e40b1/IPA.Loader/Config/Stores/Converters.cs/#L17" class="contribution-link">View Source</a>
  230. </li>
  231. </ul>
  232. </div>
  233. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  234. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  235. </nav>
  236. </div>
  237. </div>
  238. </div>
  239. </div>
  240. <footer>
  241. <div class="grad-bottom"></div>
  242. <div class="footer">
  243. <div class="container">
  244. <span class="pull-right">
  245. <a href="#top">Back to top</a>
  246. </span>
  247. <span>Generated by <strong>DocFX</strong></span>
  248. </div>
  249. </div>
  250. </footer>
  251. </div>
  252. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  253. <script type="text/javascript" src="../styles/docfx.js"></script>
  254. <script type="text/javascript" src="../styles/main.js"></script>
  255. </body>
  256. </html>