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.

345 lines
17 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.59.4.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.Data.Boolean">
  75. <h1 id="IPA_Config_Data_Boolean" data-uid="IPA.Config.Data.Boolean" class="text-break">Class Boolean
  76. </h1>
  77. <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>
  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://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><a class="xref" href="IPA.Config.Data.Value.html">Value</a></div>
  84. <div class="level2"><span class="xref">Boolean</span></div>
  85. </div>
  86. <div class="inheritedMembers">
  87. <h5>Inherited Members</h5>
  88. <div>
  89. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Null">Value.Null()</a>
  90. </div>
  91. <div>
  92. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_List">Value.List()</a>
  93. </div>
  94. <div>
  95. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Map">Value.Map()</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_String_">Value.From(String)</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Text_System_String_">Value.Text(String)</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Int64_">Value.From(Int64)</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Integer_System_Int64_">Value.Integer(Int64)</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Decimal_">Value.From(Decimal)</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Float_System_Decimal_">Value.Float(Decimal)</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Boolean_">Value.From(Boolean)</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Bool_System_Boolean_">Value.Bool(Boolean)</a>
  120. </div>
  121. <div>
  122. <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>
  123. </div>
  124. <div>
  125. <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>
  126. </div>
  127. <div>
  128. <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>
  129. </div>
  130. <div>
  131. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
  147. </div>
  148. </div>
  149. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Data.html">IPA.Config.Data</a></h6>
  150. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  151. <h5 id="IPA_Config_Data_Boolean_syntax">Syntax</h5>
  152. <div class="codewrapper">
  153. <pre><code class="lang-csharp hljs">public sealed class Boolean : Value</code></pre>
  154. </div>
  155. <h3 id="constructors">Constructors
  156. </h3>
  157. <span class="small pull-right mobile-hide">
  158. <span class="divider">|</span>
  159. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Boolean__ctor.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Boolean.%23ctor%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>
  160. </span>
  161. <span class="small pull-right mobile-hide">
  162. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/f6ebc69a5936d4b18a6aff2e56faa1b8cadc2c52/IPA.Loader/Config/Data/Primitives.cs/#L138">View Source</a>
  163. </span>
  164. <a id="IPA_Config_Data_Boolean__ctor_" data-uid="IPA.Config.Data.Boolean.#ctor*"></a>
  165. <h4 id="IPA_Config_Data_Boolean__ctor" data-uid="IPA.Config.Data.Boolean.#ctor">Boolean()</h4>
  166. <div class="markdown level1 summary"><p>Constructs an empty <a class="xref" href="IPA.Config.Data.Boolean.html">Boolean</a> object.</p>
  167. </div>
  168. <div class="markdown level1 conceptual"></div>
  169. <h5 class="decalaration">Declaration</h5>
  170. <div class="codewrapper">
  171. <pre><code class="lang-csharp hljs">[Obsolete(&quot;Use the long constructor.&quot;)]
  172. public Boolean()</code></pre>
  173. </div>
  174. <span class="small pull-right mobile-hide">
  175. <span class="divider">|</span>
  176. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Boolean__ctor_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Boolean.%23ctor(System.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>
  177. </span>
  178. <span class="small pull-right mobile-hide">
  179. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/f6ebc69a5936d4b18a6aff2e56faa1b8cadc2c52/IPA.Loader/Config/Data/Primitives.cs/#L148">View Source</a>
  180. </span>
  181. <a id="IPA_Config_Data_Boolean__ctor_" data-uid="IPA.Config.Data.Boolean.#ctor*"></a>
  182. <h4 id="IPA_Config_Data_Boolean__ctor_System_Boolean_" data-uid="IPA.Config.Data.Boolean.#ctor(System.Boolean)">Boolean(Boolean)</h4>
  183. <div class="markdown level1 summary"><p>Constructs a <a class="xref" href="IPA.Config.Data.Boolean.html">Boolean</a> object containing the provided value.</p>
  184. </div>
  185. <div class="markdown level1 conceptual"></div>
  186. <h5 class="decalaration">Declaration</h5>
  187. <div class="codewrapper">
  188. <pre><code class="lang-csharp hljs">public Boolean(bool value)</code></pre>
  189. </div>
  190. <h5 class="parameters">Parameters</h5>
  191. <table class="table table-bordered table-striped table-condensed">
  192. <thead>
  193. <tr>
  194. <th>Type</th>
  195. <th>Name</th>
  196. <th>Description</th>
  197. </tr>
  198. </thead>
  199. <tbody>
  200. <tr>
  201. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  202. <td><span class="parametername">value</span></td>
  203. <td><p>The value to construct with.</p>
  204. </td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <h3 id="properties">Properties
  209. </h3>
  210. <span class="small pull-right mobile-hide">
  211. <span class="divider">|</span>
  212. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/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>
  213. </span>
  214. <span class="small pull-right mobile-hide">
  215. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/f6ebc69a5936d4b18a6aff2e56faa1b8cadc2c52/IPA.Loader/Config/Data/Primitives.cs/#L156">View Source</a>
  216. </span>
  217. <a id="IPA_Config_Data_Boolean_Value_" data-uid="IPA.Config.Data.Boolean.Value*"></a>
  218. <h4 id="IPA_Config_Data_Boolean_Value" data-uid="IPA.Config.Data.Boolean.Value">Value</h4>
  219. <div class="markdown level1 summary"><p>The actual value fo this <a class="xref" href="IPA.Config.Data.Boolean.html">Boolean</a> object.</p>
  220. </div>
  221. <div class="markdown level1 conceptual"></div>
  222. <h5 class="decalaration">Declaration</h5>
  223. <div class="codewrapper">
  224. <pre><code class="lang-csharp hljs">public bool Value { get; set; }</code></pre>
  225. </div>
  226. <h5 class="propertyValue">Property Value</h5>
  227. <table class="table table-bordered table-striped table-condensed">
  228. <thead>
  229. <tr>
  230. <th>Type</th>
  231. <th>Description</th>
  232. </tr>
  233. </thead>
  234. <tbody>
  235. <tr>
  236. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  237. <td></td>
  238. </tr>
  239. </tbody>
  240. </table>
  241. <h3 id="methods">Methods
  242. </h3>
  243. <span class="small pull-right mobile-hide">
  244. <span class="divider">|</span>
  245. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/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>
  246. </span>
  247. <span class="small pull-right mobile-hide">
  248. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/f6ebc69a5936d4b18a6aff2e56faa1b8cadc2c52/IPA.Loader/Config/Data/Primitives.cs/#L163">View Source</a>
  249. </span>
  250. <a id="IPA_Config_Data_Boolean_ToString_" data-uid="IPA.Config.Data.Boolean.ToString*"></a>
  251. <h4 id="IPA_Config_Data_Boolean_ToString" data-uid="IPA.Config.Data.Boolean.ToString">ToString()</h4>
  252. <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>
  253. </div>
  254. <div class="markdown level1 conceptual"></div>
  255. <h5 class="decalaration">Declaration</h5>
  256. <div class="codewrapper">
  257. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  258. </div>
  259. <h5 class="returns">Returns</h5>
  260. <table class="table table-bordered table-striped table-condensed">
  261. <thead>
  262. <tr>
  263. <th>Type</th>
  264. <th>Description</th>
  265. </tr>
  266. </thead>
  267. <tbody>
  268. <tr>
  269. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
  270. <td><p>the result of <code>Value.ToString().ToLower()</code></p>
  271. </td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <h5 class="overrides">Overrides</h5>
  276. <div><a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_ToString">Value.ToString()</a></div>
  277. <h3 id="extensionmethods">Extension Methods</h3>
  278. <div>
  279. <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>
  280. </div>
  281. <div>
  282. <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>
  283. </div>
  284. <div>
  285. <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>
  286. </div>
  287. <div>
  288. <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>
  289. </div>
  290. <div>
  291. <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>
  292. </div>
  293. </article>
  294. </div>
  295. <div class="hidden-sm col-md-2" role="complementary">
  296. <div class="sideaffix">
  297. <div class="contribution">
  298. <ul class="nav">
  299. <li>
  300. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/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>
  301. </li>
  302. <li>
  303. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/f6ebc69a5936d4b18a6aff2e56faa1b8cadc2c52/IPA.Loader/Config/Data/Primitives.cs/#L133" class="contribution-link">View Source</a>
  304. </li>
  305. </ul>
  306. </div>
  307. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  308. <h5>In This Article</h5>
  309. <div></div>
  310. </nav>
  311. </div>
  312. </div>
  313. </div>
  314. </div>
  315. <footer>
  316. <div class="grad-bottom"></div>
  317. <div class="footer">
  318. <div class="container">
  319. <span class="pull-right">
  320. <a href="#top">Back to top</a>
  321. </span>
  322. <span>Generated by <strong>DocFX</strong></span>
  323. </div>
  324. </div>
  325. </footer>
  326. </div>
  327. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  328. <script type="text/javascript" src="../styles/docfx.js"></script>
  329. <script type="text/javascript" src="../styles/main.js"></script>
  330. </body>
  331. </html>