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.

652 lines
29 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>Interface IModPrefs
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IModPrefs
  11. ">
  12. <meta name="generator" content="docfx 2.42.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. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../index.html">
  33. <img id="logo" class="svg" src="../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="IPA.Config.IModPrefs">
  63. <h1 id="IPA_Config_IModPrefs" data-uid="IPA.Config.IModPrefs" class="text-break">Interface IModPrefs
  64. </h1>
  65. <div class="markdown level0 summary"><p>Allows to get and set preferences for your mod.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  69. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  70. <h5 id="IPA_Config_IModPrefs_syntax">Syntax</h5>
  71. <div class="codewrapper">
  72. <pre><code class="lang-csharp hljs">[Obsolete(&quot;Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.&quot;)]
  73. public interface IModPrefs</code></pre>
  74. </div>
  75. <h3 id="methods">Methods
  76. </h3>
  77. <span class="small pull-right mobile-hide">
  78. <span class="divider">|</span>
  79. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_GetBool_System_String_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.GetBool(System.String%2CSystem.String%2CSystem.Boolean%2CSystem.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>
  80. </span>
  81. <span class="small pull-right mobile-hide">
  82. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L49">View Source</a>
  83. </span>
  84. <a id="IPA_Config_IModPrefs_GetBool_" data-uid="IPA.Config.IModPrefs.GetBool*"></a>
  85. <h4 id="IPA_Config_IModPrefs_GetBool_System_String_System_String_System_Boolean_System_Boolean_" data-uid="IPA.Config.IModPrefs.GetBool(System.String,System.String,System.Boolean,System.Boolean)">GetBool(String, String, Boolean, Boolean)</h4>
  86. <div class="markdown level1 summary"><p>Gets a bool from the ini.</p>
  87. </div>
  88. <div class="markdown level1 conceptual"></div>
  89. <h5 class="decalaration">Declaration</h5>
  90. <div class="codewrapper">
  91. <pre><code class="lang-csharp hljs">bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false)</code></pre>
  92. </div>
  93. <h5 class="parameters">Parameters</h5>
  94. <table class="table table-bordered table-striped table-condensed">
  95. <thead>
  96. <tr>
  97. <th>Type</th>
  98. <th>Name</th>
  99. <th>Description</th>
  100. </tr>
  101. </thead>
  102. <tbody>
  103. <tr>
  104. <td><span class="xref">System.String</span></td>
  105. <td><span class="parametername">section</span></td>
  106. <td><p>Section of the key.</p>
  107. </td>
  108. </tr>
  109. <tr>
  110. <td><span class="xref">System.String</span></td>
  111. <td><span class="parametername">name</span></td>
  112. <td><p>Name of the key.</p>
  113. </td>
  114. </tr>
  115. <tr>
  116. <td><span class="xref">System.Boolean</span></td>
  117. <td><span class="parametername">defaultValue</span></td>
  118. <td><p>Value that should be used when no value is found.</p>
  119. </td>
  120. </tr>
  121. <tr>
  122. <td><span class="xref">System.Boolean</span></td>
  123. <td><span class="parametername">autoSave</span></td>
  124. <td><p>Whether or not the default value should be written if no value is found.</p>
  125. </td>
  126. </tr>
  127. </tbody>
  128. </table>
  129. <h5 class="returns">Returns</h5>
  130. <table class="table table-bordered table-striped table-condensed">
  131. <thead>
  132. <tr>
  133. <th>Type</th>
  134. <th>Description</th>
  135. </tr>
  136. </thead>
  137. <tbody>
  138. <tr>
  139. <td><span class="xref">System.Boolean</span></td>
  140. <td></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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_GetFloat_System_String_System_String_System_Single_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.GetFloat(System.String%2CSystem.String%2CSystem.Single%2CSystem.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>
  147. </span>
  148. <span class="small pull-right mobile-hide">
  149. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L40">View Source</a>
  150. </span>
  151. <a id="IPA_Config_IModPrefs_GetFloat_" data-uid="IPA.Config.IModPrefs.GetFloat*"></a>
  152. <h4 id="IPA_Config_IModPrefs_GetFloat_System_String_System_String_System_Single_System_Boolean_" data-uid="IPA.Config.IModPrefs.GetFloat(System.String,System.String,System.Single,System.Boolean)">GetFloat(String, String, Single, Boolean)</h4>
  153. <div class="markdown level1 summary"><p>Gets a float from the ini.</p>
  154. </div>
  155. <div class="markdown level1 conceptual"></div>
  156. <h5 class="decalaration">Declaration</h5>
  157. <div class="codewrapper">
  158. <pre><code class="lang-csharp hljs">float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false)</code></pre>
  159. </div>
  160. <h5 class="parameters">Parameters</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Name</th>
  166. <th>Description</th>
  167. </tr>
  168. </thead>
  169. <tbody>
  170. <tr>
  171. <td><span class="xref">System.String</span></td>
  172. <td><span class="parametername">section</span></td>
  173. <td><p>Section of the key.</p>
  174. </td>
  175. </tr>
  176. <tr>
  177. <td><span class="xref">System.String</span></td>
  178. <td><span class="parametername">name</span></td>
  179. <td><p>Name of the key.</p>
  180. </td>
  181. </tr>
  182. <tr>
  183. <td><span class="xref">System.Single</span></td>
  184. <td><span class="parametername">defaultValue</span></td>
  185. <td><p>Value that should be used when no value is found.</p>
  186. </td>
  187. </tr>
  188. <tr>
  189. <td><span class="xref">System.Boolean</span></td>
  190. <td><span class="parametername">autoSave</span></td>
  191. <td><p>Whether or not the default value should be written if no value is found.</p>
  192. </td>
  193. </tr>
  194. </tbody>
  195. </table>
  196. <h5 class="returns">Returns</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><span class="xref">System.Single</span></td>
  207. <td></td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <span class="small pull-right mobile-hide">
  212. <span class="divider">|</span>
  213. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_GetInt_System_String_System_String_System_Int32_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.GetInt(System.String%2CSystem.String%2CSystem.Int32%2CSystem.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>
  214. </span>
  215. <span class="small pull-right mobile-hide">
  216. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L31">View Source</a>
  217. </span>
  218. <a id="IPA_Config_IModPrefs_GetInt_" data-uid="IPA.Config.IModPrefs.GetInt*"></a>
  219. <h4 id="IPA_Config_IModPrefs_GetInt_System_String_System_String_System_Int32_System_Boolean_" data-uid="IPA.Config.IModPrefs.GetInt(System.String,System.String,System.Int32,System.Boolean)">GetInt(String, String, Int32, Boolean)</h4>
  220. <div class="markdown level1 summary"><p>Gets an int from the ini.</p>
  221. </div>
  222. <div class="markdown level1 conceptual"></div>
  223. <h5 class="decalaration">Declaration</h5>
  224. <div class="codewrapper">
  225. <pre><code class="lang-csharp hljs">int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false)</code></pre>
  226. </div>
  227. <h5 class="parameters">Parameters</h5>
  228. <table class="table table-bordered table-striped table-condensed">
  229. <thead>
  230. <tr>
  231. <th>Type</th>
  232. <th>Name</th>
  233. <th>Description</th>
  234. </tr>
  235. </thead>
  236. <tbody>
  237. <tr>
  238. <td><span class="xref">System.String</span></td>
  239. <td><span class="parametername">section</span></td>
  240. <td><p>Section of the key.</p>
  241. </td>
  242. </tr>
  243. <tr>
  244. <td><span class="xref">System.String</span></td>
  245. <td><span class="parametername">name</span></td>
  246. <td><p>Name of the key.</p>
  247. </td>
  248. </tr>
  249. <tr>
  250. <td><span class="xref">System.Int32</span></td>
  251. <td><span class="parametername">defaultValue</span></td>
  252. <td><p>Value that should be used when no value is found.</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <td><span class="xref">System.Boolean</span></td>
  257. <td><span class="parametername">autoSave</span></td>
  258. <td><p>Whether or not the default value should be written if no value is found.</p>
  259. </td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. <h5 class="returns">Returns</h5>
  264. <table class="table table-bordered table-striped table-condensed">
  265. <thead>
  266. <tr>
  267. <th>Type</th>
  268. <th>Description</th>
  269. </tr>
  270. </thead>
  271. <tbody>
  272. <tr>
  273. <td><span class="xref">System.Int32</span></td>
  274. <td></td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. <span class="small pull-right mobile-hide">
  279. <span class="divider">|</span>
  280. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_GetString_System_String_System_String_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.GetString(System.String%2CSystem.String%2CSystem.String%2CSystem.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>
  281. </span>
  282. <span class="small pull-right mobile-hide">
  283. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L22">View Source</a>
  284. </span>
  285. <a id="IPA_Config_IModPrefs_GetString_" data-uid="IPA.Config.IModPrefs.GetString*"></a>
  286. <h4 id="IPA_Config_IModPrefs_GetString_System_String_System_String_System_String_System_Boolean_" data-uid="IPA.Config.IModPrefs.GetString(System.String,System.String,System.String,System.Boolean)">GetString(String, String, String, Boolean)</h4>
  287. <div class="markdown level1 summary"><p>Gets a string from the ini.</p>
  288. </div>
  289. <div class="markdown level1 conceptual"></div>
  290. <h5 class="decalaration">Declaration</h5>
  291. <div class="codewrapper">
  292. <pre><code class="lang-csharp hljs">string GetString(string section, string name, string defaultValue = &quot;&quot;, bool autoSave = false)</code></pre>
  293. </div>
  294. <h5 class="parameters">Parameters</h5>
  295. <table class="table table-bordered table-striped table-condensed">
  296. <thead>
  297. <tr>
  298. <th>Type</th>
  299. <th>Name</th>
  300. <th>Description</th>
  301. </tr>
  302. </thead>
  303. <tbody>
  304. <tr>
  305. <td><span class="xref">System.String</span></td>
  306. <td><span class="parametername">section</span></td>
  307. <td><p>Section of the key.</p>
  308. </td>
  309. </tr>
  310. <tr>
  311. <td><span class="xref">System.String</span></td>
  312. <td><span class="parametername">name</span></td>
  313. <td><p>Name of the key.</p>
  314. </td>
  315. </tr>
  316. <tr>
  317. <td><span class="xref">System.String</span></td>
  318. <td><span class="parametername">defaultValue</span></td>
  319. <td><p>Value that should be used when no value is found.</p>
  320. </td>
  321. </tr>
  322. <tr>
  323. <td><span class="xref">System.Boolean</span></td>
  324. <td><span class="parametername">autoSave</span></td>
  325. <td><p>Whether or not the default value should be written if no value is found.</p>
  326. </td>
  327. </tr>
  328. </tbody>
  329. </table>
  330. <h5 class="returns">Returns</h5>
  331. <table class="table table-bordered table-striped table-condensed">
  332. <thead>
  333. <tr>
  334. <th>Type</th>
  335. <th>Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td><span class="xref">System.String</span></td>
  341. <td></td>
  342. </tr>
  343. </tbody>
  344. </table>
  345. <span class="small pull-right mobile-hide">
  346. <span class="divider">|</span>
  347. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_HasKey_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.HasKey(System.String%2CSystem.String)%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>
  348. </span>
  349. <span class="small pull-right mobile-hide">
  350. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L56">View Source</a>
  351. </span>
  352. <a id="IPA_Config_IModPrefs_HasKey_" data-uid="IPA.Config.IModPrefs.HasKey*"></a>
  353. <h4 id="IPA_Config_IModPrefs_HasKey_System_String_System_String_" data-uid="IPA.Config.IModPrefs.HasKey(System.String,System.String)">HasKey(String, String)</h4>
  354. <div class="markdown level1 summary"><p>Checks whether or not a key exists in the ini.</p>
  355. </div>
  356. <div class="markdown level1 conceptual"></div>
  357. <h5 class="decalaration">Declaration</h5>
  358. <div class="codewrapper">
  359. <pre><code class="lang-csharp hljs">bool HasKey(string section, string name)</code></pre>
  360. </div>
  361. <h5 class="parameters">Parameters</h5>
  362. <table class="table table-bordered table-striped table-condensed">
  363. <thead>
  364. <tr>
  365. <th>Type</th>
  366. <th>Name</th>
  367. <th>Description</th>
  368. </tr>
  369. </thead>
  370. <tbody>
  371. <tr>
  372. <td><span class="xref">System.String</span></td>
  373. <td><span class="parametername">section</span></td>
  374. <td><p>Section of the key.</p>
  375. </td>
  376. </tr>
  377. <tr>
  378. <td><span class="xref">System.String</span></td>
  379. <td><span class="parametername">name</span></td>
  380. <td><p>Name of the key.</p>
  381. </td>
  382. </tr>
  383. </tbody>
  384. </table>
  385. <h5 class="returns">Returns</h5>
  386. <table class="table table-bordered table-striped table-condensed">
  387. <thead>
  388. <tr>
  389. <th>Type</th>
  390. <th>Description</th>
  391. </tr>
  392. </thead>
  393. <tbody>
  394. <tr>
  395. <td><span class="xref">System.Boolean</span></td>
  396. <td></td>
  397. </tr>
  398. </tbody>
  399. </table>
  400. <span class="small pull-right mobile-hide">
  401. <span class="divider">|</span>
  402. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_SetBool_System_String_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.SetBool(System.String%2CSystem.String%2CSystem.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>
  403. </span>
  404. <span class="small pull-right mobile-hide">
  405. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L84">View Source</a>
  406. </span>
  407. <a id="IPA_Config_IModPrefs_SetBool_" data-uid="IPA.Config.IModPrefs.SetBool*"></a>
  408. <h4 id="IPA_Config_IModPrefs_SetBool_System_String_System_String_System_Boolean_" data-uid="IPA.Config.IModPrefs.SetBool(System.String,System.String,System.Boolean)">SetBool(String, String, Boolean)</h4>
  409. <div class="markdown level1 summary"><p>Sets a bool in the ini.</p>
  410. </div>
  411. <div class="markdown level1 conceptual"></div>
  412. <h5 class="decalaration">Declaration</h5>
  413. <div class="codewrapper">
  414. <pre><code class="lang-csharp hljs">void SetBool(string section, string name, bool value)</code></pre>
  415. </div>
  416. <h5 class="parameters">Parameters</h5>
  417. <table class="table table-bordered table-striped table-condensed">
  418. <thead>
  419. <tr>
  420. <th>Type</th>
  421. <th>Name</th>
  422. <th>Description</th>
  423. </tr>
  424. </thead>
  425. <tbody>
  426. <tr>
  427. <td><span class="xref">System.String</span></td>
  428. <td><span class="parametername">section</span></td>
  429. <td><p>Section of the key.</p>
  430. </td>
  431. </tr>
  432. <tr>
  433. <td><span class="xref">System.String</span></td>
  434. <td><span class="parametername">name</span></td>
  435. <td><p>Name of the key.</p>
  436. </td>
  437. </tr>
  438. <tr>
  439. <td><span class="xref">System.Boolean</span></td>
  440. <td><span class="parametername">value</span></td>
  441. <td><p>Value that should be written.</p>
  442. </td>
  443. </tr>
  444. </tbody>
  445. </table>
  446. <span class="small pull-right mobile-hide">
  447. <span class="divider">|</span>
  448. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_SetFloat_System_String_System_String_System_Single_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.SetFloat(System.String%2CSystem.String%2CSystem.Single)%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>
  449. </span>
  450. <span class="small pull-right mobile-hide">
  451. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L63">View Source</a>
  452. </span>
  453. <a id="IPA_Config_IModPrefs_SetFloat_" data-uid="IPA.Config.IModPrefs.SetFloat*"></a>
  454. <h4 id="IPA_Config_IModPrefs_SetFloat_System_String_System_String_System_Single_" data-uid="IPA.Config.IModPrefs.SetFloat(System.String,System.String,System.Single)">SetFloat(String, String, Single)</h4>
  455. <div class="markdown level1 summary"><p>Sets a float in the ini.</p>
  456. </div>
  457. <div class="markdown level1 conceptual"></div>
  458. <h5 class="decalaration">Declaration</h5>
  459. <div class="codewrapper">
  460. <pre><code class="lang-csharp hljs">void SetFloat(string section, string name, float value)</code></pre>
  461. </div>
  462. <h5 class="parameters">Parameters</h5>
  463. <table class="table table-bordered table-striped table-condensed">
  464. <thead>
  465. <tr>
  466. <th>Type</th>
  467. <th>Name</th>
  468. <th>Description</th>
  469. </tr>
  470. </thead>
  471. <tbody>
  472. <tr>
  473. <td><span class="xref">System.String</span></td>
  474. <td><span class="parametername">section</span></td>
  475. <td><p>Section of the key.</p>
  476. </td>
  477. </tr>
  478. <tr>
  479. <td><span class="xref">System.String</span></td>
  480. <td><span class="parametername">name</span></td>
  481. <td><p>Name of the key.</p>
  482. </td>
  483. </tr>
  484. <tr>
  485. <td><span class="xref">System.Single</span></td>
  486. <td><span class="parametername">value</span></td>
  487. <td><p>Value that should be written.</p>
  488. </td>
  489. </tr>
  490. </tbody>
  491. </table>
  492. <span class="small pull-right mobile-hide">
  493. <span class="divider">|</span>
  494. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_SetInt_System_String_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.SetInt(System.String%2CSystem.String%2CSystem.Int32)%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>
  495. </span>
  496. <span class="small pull-right mobile-hide">
  497. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L70">View Source</a>
  498. </span>
  499. <a id="IPA_Config_IModPrefs_SetInt_" data-uid="IPA.Config.IModPrefs.SetInt*"></a>
  500. <h4 id="IPA_Config_IModPrefs_SetInt_System_String_System_String_System_Int32_" data-uid="IPA.Config.IModPrefs.SetInt(System.String,System.String,System.Int32)">SetInt(String, String, Int32)</h4>
  501. <div class="markdown level1 summary"><p>Sets an int in the ini.</p>
  502. </div>
  503. <div class="markdown level1 conceptual"></div>
  504. <h5 class="decalaration">Declaration</h5>
  505. <div class="codewrapper">
  506. <pre><code class="lang-csharp hljs">void SetInt(string section, string name, int value)</code></pre>
  507. </div>
  508. <h5 class="parameters">Parameters</h5>
  509. <table class="table table-bordered table-striped table-condensed">
  510. <thead>
  511. <tr>
  512. <th>Type</th>
  513. <th>Name</th>
  514. <th>Description</th>
  515. </tr>
  516. </thead>
  517. <tbody>
  518. <tr>
  519. <td><span class="xref">System.String</span></td>
  520. <td><span class="parametername">section</span></td>
  521. <td><p>Section of the key.</p>
  522. </td>
  523. </tr>
  524. <tr>
  525. <td><span class="xref">System.String</span></td>
  526. <td><span class="parametername">name</span></td>
  527. <td><p>Name of the key.</p>
  528. </td>
  529. </tr>
  530. <tr>
  531. <td><span class="xref">System.Int32</span></td>
  532. <td><span class="parametername">value</span></td>
  533. <td><p>Value that should be written.</p>
  534. </td>
  535. </tr>
  536. </tbody>
  537. </table>
  538. <span class="small pull-right mobile-hide">
  539. <span class="divider">|</span>
  540. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs_SetString_System_String_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs.SetString(System.String%2CSystem.String%2CSystem.String)%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>
  541. </span>
  542. <span class="small pull-right mobile-hide">
  543. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L77">View Source</a>
  544. </span>
  545. <a id="IPA_Config_IModPrefs_SetString_" data-uid="IPA.Config.IModPrefs.SetString*"></a>
  546. <h4 id="IPA_Config_IModPrefs_SetString_System_String_System_String_System_String_" data-uid="IPA.Config.IModPrefs.SetString(System.String,System.String,System.String)">SetString(String, String, String)</h4>
  547. <div class="markdown level1 summary"><p>Sets a string in the ini.</p>
  548. </div>
  549. <div class="markdown level1 conceptual"></div>
  550. <h5 class="decalaration">Declaration</h5>
  551. <div class="codewrapper">
  552. <pre><code class="lang-csharp hljs">void SetString(string section, string name, string value)</code></pre>
  553. </div>
  554. <h5 class="parameters">Parameters</h5>
  555. <table class="table table-bordered table-striped table-condensed">
  556. <thead>
  557. <tr>
  558. <th>Type</th>
  559. <th>Name</th>
  560. <th>Description</th>
  561. </tr>
  562. </thead>
  563. <tbody>
  564. <tr>
  565. <td><span class="xref">System.String</span></td>
  566. <td><span class="parametername">section</span></td>
  567. <td><p>Section of the key.</p>
  568. </td>
  569. </tr>
  570. <tr>
  571. <td><span class="xref">System.String</span></td>
  572. <td><span class="parametername">name</span></td>
  573. <td><p>Name of the key.</p>
  574. </td>
  575. </tr>
  576. <tr>
  577. <td><span class="xref">System.String</span></td>
  578. <td><span class="parametername">value</span></td>
  579. <td><p>Value that should be written.</p>
  580. </td>
  581. </tr>
  582. </tbody>
  583. </table>
  584. <h3 id="extensionmethods">Extension Methods</h3>
  585. <div>
  586. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  587. </div>
  588. <div>
  589. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetPrivateField__1_System_Object_System_String_">ReflectionUtil.GetPrivateField&lt;T&gt;(Object, String)</a>
  590. </div>
  591. <div>
  592. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  593. </div>
  594. <div>
  595. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  596. </div>
  597. <div>
  598. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod&lt;T&gt;(Object, String, Object[])</a>
  599. </div>
  600. </article>
  601. </div>
  602. <div class="hidden-sm col-md-2" role="complementary">
  603. <div class="sideaffix">
  604. <div class="contribution">
  605. <ul class="nav">
  606. <li>
  607. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_IModPrefs.md&amp;value=---%0Auid%3A%20IPA.Config.IModPrefs%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>
  608. </li>
  609. <li>
  610. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/ModPrefs.cs/#L11" class="contribution-link">View Source</a>
  611. </li>
  612. </ul>
  613. </div>
  614. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  615. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  616. </nav>
  617. </div>
  618. </div>
  619. </div>
  620. </div>
  621. <footer>
  622. <div class="grad-bottom"></div>
  623. <div class="footer">
  624. <div class="container">
  625. <span class="pull-right">
  626. <a href="#top">Back to top</a>
  627. </span>
  628. <span>Generated by <strong>DocFX</strong></span>
  629. </div>
  630. </div>
  631. </footer>
  632. </div>
  633. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  634. <script type="text/javascript" src="../styles/docfx.js"></script>
  635. <script type="text/javascript" src="../styles/main.js"></script>
  636. </body>
  637. </html>