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.

302 lines
15 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 Boolean
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Boolean
  11. ">
  12. <meta name="generator" content="docfx 2.48.0.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 href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../">
  21. <meta property="docfx:newtab" content="true">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../index.html">
  35. <img id="logo" class="svg" src="../logo.svg" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list"></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="IPA.Config.Data.Boolean">
  74. <h1 id="IPA_Config_Data_Boolean" data-uid="IPA.Config.Data.Boolean" class="text-break">Class Boolean
  75. </h1>
  76. <div class="markdown level0 summary"><p>A <a class="xref" href="IPA.Config.Data.Boolean.html#IPA_Config_Data_Boolean_Value">Value</a> representing a boolean value.</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  82. <div class="level1"><a class="xref" href="IPA.Config.Data.Value.html">Value</a></div>
  83. <div class="level2"><span class="xref">Boolean</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Null">Value.Null()</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_List">Value.List()</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Map">Value.Map()</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_String_">Value.From(String)</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Text_System_String_">Value.Text(String)</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Int64_">Value.From(Int64)</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Integer_System_Int64_">Value.Integer(Int64)</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Decimal_">Value.From(Decimal)</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Float_System_Decimal_">Value.Float(Decimal)</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Boolean_">Value.From(Boolean)</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Bool_System_Boolean_">Value.Bool(Boolean)</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Collections_Generic_IEnumerable_IPA_Config_Data_Value__">Value.From(IEnumerable&lt;Value&gt;)</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Collections_Generic_IDictionary_System_String_IPA_Config_Data_Value__">Value.From(IDictionary&lt;String, Value&gt;)</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Collections_Generic_IEnumerable_System_Collections_Generic_KeyValuePair_System_String_IPA_Config_Data_Value___">Value.From(IEnumerable&lt;KeyValuePair&lt;String, Value&gt;&gt;)</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  131. </div>
  132. <div>
  133. <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>
  134. </div>
  135. <div>
  136. <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>
  137. </div>
  138. <div>
  139. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  146. </div>
  147. </div>
  148. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Data.html">IPA.Config.Data</a></h6>
  149. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  150. <h5 id="IPA_Config_Data_Boolean_syntax">Syntax</h5>
  151. <div class="codewrapper">
  152. <pre><code class="lang-csharp hljs">public sealed class Boolean : Value</code></pre>
  153. </div>
  154. <h3 id="properties">Properties
  155. </h3>
  156. <span class="small pull-right mobile-hide">
  157. <span class="divider">|</span>
  158. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_Data_Boolean_Value.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Boolean.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>
  159. </span>
  160. <span class="small pull-right mobile-hide">
  161. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d3ed99a9a9174e11906a53dd1af9c54d55bfbbfc/IPA.Loader/Config/Data/Primitives.cs/#L83">View Source</a>
  162. </span>
  163. <a id="IPA_Config_Data_Boolean_Value_" data-uid="IPA.Config.Data.Boolean.Value*"></a>
  164. <h4 id="IPA_Config_Data_Boolean_Value" data-uid="IPA.Config.Data.Boolean.Value">Value</h4>
  165. <div class="markdown level1 summary"><p>The actual value fo this <a class="xref" href="IPA.Config.Data.Boolean.html">Boolean</a> object.</p>
  166. </div>
  167. <div class="markdown level1 conceptual"></div>
  168. <h5 class="decalaration">Declaration</h5>
  169. <div class="codewrapper">
  170. <pre><code class="lang-csharp hljs">public bool Value { get; set; }</code></pre>
  171. </div>
  172. <h5 class="propertyValue">Property Value</h5>
  173. <table class="table table-bordered table-striped table-condensed">
  174. <thead>
  175. <tr>
  176. <th>Type</th>
  177. <th>Description</th>
  178. </tr>
  179. </thead>
  180. <tbody>
  181. <tr>
  182. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  183. <td></td>
  184. </tr>
  185. </tbody>
  186. </table>
  187. <h3 id="methods">Methods
  188. </h3>
  189. <span class="small pull-right mobile-hide">
  190. <span class="divider">|</span>
  191. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_Data_Boolean_ToString.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Boolean.ToString%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>
  192. </span>
  193. <span class="small pull-right mobile-hide">
  194. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d3ed99a9a9174e11906a53dd1af9c54d55bfbbfc/IPA.Loader/Config/Data/Primitives.cs/#L89">View Source</a>
  195. </span>
  196. <a id="IPA_Config_Data_Boolean_ToString_" data-uid="IPA.Config.Data.Boolean.ToString*"></a>
  197. <h4 id="IPA_Config_Data_Boolean_ToString" data-uid="IPA.Config.Data.Boolean.ToString">ToString()</h4>
  198. <div class="markdown level1 summary"><p>Converts this <a class="xref" href="IPA.Config.Data.Value.html">Value</a> into a human-readable format.</p>
  199. </div>
  200. <div class="markdown level1 conceptual"></div>
  201. <h5 class="decalaration">Declaration</h5>
  202. <div class="codewrapper">
  203. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  204. </div>
  205. <h5 class="returns">Returns</h5>
  206. <table class="table table-bordered table-striped table-condensed">
  207. <thead>
  208. <tr>
  209. <th>Type</th>
  210. <th>Description</th>
  211. </tr>
  212. </thead>
  213. <tbody>
  214. <tr>
  215. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  216. <td><p>the result of <code>Value.ToString().ToLower()</code></p>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <h5 class="overrides">Overrides</h5>
  222. <div><a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_ToString">Value.ToString()</a></div>
  223. <h3 id="extensionmethods">Extension Methods</h3>
  224. <div>
  225. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField_System_Object_System_String_System_Object_">ReflectionUtil.SetField(Object, String, Object)</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__1___0_System_String_System_Object_">ReflectionUtil.SetField&lt;T&gt;(T, String, Object)</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__1_System_Object_System_String_">ReflectionUtil.GetField&lt;T&gt;(Object, String)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetProperty(Object, String, Object)</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__1___0_System_String_System_Object_">ReflectionUtil.SetProperty&lt;T&gt;(T, String, Object)</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod(Object, String, Object[])</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1___0_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(T, String, Object[])</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(Object, String, Object[])</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T, U&gt;(U, String, Object[])</a>
  250. </div>
  251. </article>
  252. </div>
  253. <div class="hidden-sm col-md-2" role="complementary">
  254. <div class="sideaffix">
  255. <div class="contribution">
  256. <ul class="nav">
  257. <li>
  258. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Config_Data_Boolean.md&amp;value=---%0Auid%3A%20IPA.Config.Data.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" class="contribution-link">Improve this Doc</a>
  259. </li>
  260. <li>
  261. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d3ed99a9a9174e11906a53dd1af9c54d55bfbbfc/IPA.Loader/Config/Data/Primitives.cs/#L78" class="contribution-link">View Source</a>
  262. </li>
  263. </ul>
  264. </div>
  265. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  266. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  267. </nav>
  268. </div>
  269. </div>
  270. </div>
  271. </div>
  272. <footer>
  273. <div class="grad-bottom"></div>
  274. <div class="footer">
  275. <div class="container">
  276. <span class="pull-right">
  277. <a href="#top">Back to top</a>
  278. </span>
  279. <span>Generated by <strong>DocFX</strong></span>
  280. </div>
  281. </div>
  282. </footer>
  283. </div>
  284. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  285. <script type="text/javascript" src="../styles/docfx.js"></script>
  286. <script type="text/javascript" src="../styles/main.js"></script>
  287. </body>
  288. </html>