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.

663 lines
31 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.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 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.IModPrefs">
  75. <h1 id="IPA_Config_IModPrefs" data-uid="IPA.Config.IModPrefs" class="text-break">Interface IModPrefs
  76. </h1>
  77. <div class="markdown level0 summary"><p>Allows to get and set preferences for your mod. </p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  81. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  82. <h5 id="IPA_Config_IModPrefs_syntax">Syntax</h5>
  83. <div class="codewrapper">
  84. <pre><code class="lang-csharp hljs">[Obsolete(&quot;Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.&quot;)]
  85. public interface IModPrefs</code></pre>
  86. </div>
  87. <h3 id="methods">Methods
  88. </h3>
  89. <span class="small pull-right mobile-hide">
  90. <span class="divider">|</span>
  91. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  92. </span>
  93. <span class="small pull-right mobile-hide">
  94. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L52">View Source</a>
  95. </span>
  96. <a id="IPA_Config_IModPrefs_GetBool_" data-uid="IPA.Config.IModPrefs.GetBool*"></a>
  97. <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>
  98. <div class="markdown level1 summary"><p>Gets a bool from the ini.</p>
  99. </div>
  100. <div class="markdown level1 conceptual"></div>
  101. <h5 class="decalaration">Declaration</h5>
  102. <div class="codewrapper">
  103. <pre><code class="lang-csharp hljs">bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false)</code></pre>
  104. </div>
  105. <h5 class="parameters">Parameters</h5>
  106. <table class="table table-bordered table-striped table-condensed">
  107. <thead>
  108. <tr>
  109. <th>Type</th>
  110. <th>Name</th>
  111. <th>Description</th>
  112. </tr>
  113. </thead>
  114. <tbody>
  115. <tr>
  116. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  117. <td><span class="parametername">section</span></td>
  118. <td><p>Section of the key.</p>
  119. </td>
  120. </tr>
  121. <tr>
  122. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  123. <td><span class="parametername">name</span></td>
  124. <td><p>Name of the key.</p>
  125. </td>
  126. </tr>
  127. <tr>
  128. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  129. <td><span class="parametername">defaultValue</span></td>
  130. <td><p>Value that should be used when no value is found.</p>
  131. </td>
  132. </tr>
  133. <tr>
  134. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  135. <td><span class="parametername">autoSave</span></td>
  136. <td><p>Whether or not the default value should be written if no value is found.</p>
  137. </td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <h5 class="returns">Returns</h5>
  142. <table class="table table-bordered table-striped table-condensed">
  143. <thead>
  144. <tr>
  145. <th>Type</th>
  146. <th>Description</th>
  147. </tr>
  148. </thead>
  149. <tbody>
  150. <tr>
  151. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  152. <td></td>
  153. </tr>
  154. </tbody>
  155. </table>
  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/master/docs/override/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>
  159. </span>
  160. <span class="small pull-right mobile-hide">
  161. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L43">View Source</a>
  162. </span>
  163. <a id="IPA_Config_IModPrefs_GetFloat_" data-uid="IPA.Config.IModPrefs.GetFloat*"></a>
  164. <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>
  165. <div class="markdown level1 summary"><p>Gets a float from the ini.</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">float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false)</code></pre>
  171. </div>
  172. <h5 class="parameters">Parameters</h5>
  173. <table class="table table-bordered table-striped table-condensed">
  174. <thead>
  175. <tr>
  176. <th>Type</th>
  177. <th>Name</th>
  178. <th>Description</th>
  179. </tr>
  180. </thead>
  181. <tbody>
  182. <tr>
  183. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  184. <td><span class="parametername">section</span></td>
  185. <td><p>Section of the key.</p>
  186. </td>
  187. </tr>
  188. <tr>
  189. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  190. <td><span class="parametername">name</span></td>
  191. <td><p>Name of the key.</p>
  192. </td>
  193. </tr>
  194. <tr>
  195. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.single">Single</a></td>
  196. <td><span class="parametername">defaultValue</span></td>
  197. <td><p>Value that should be used when no value is found.</p>
  198. </td>
  199. </tr>
  200. <tr>
  201. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  202. <td><span class="parametername">autoSave</span></td>
  203. <td><p>Whether or not the default value should be written if no value is found.</p>
  204. </td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <h5 class="returns">Returns</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Type</th>
  213. <th>Description</th>
  214. </tr>
  215. </thead>
  216. <tbody>
  217. <tr>
  218. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.single">Single</a></td>
  219. <td></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <span class="small pull-right mobile-hide">
  224. <span class="divider">|</span>
  225. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  226. </span>
  227. <span class="small pull-right mobile-hide">
  228. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L34">View Source</a>
  229. </span>
  230. <a id="IPA_Config_IModPrefs_GetInt_" data-uid="IPA.Config.IModPrefs.GetInt*"></a>
  231. <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>
  232. <div class="markdown level1 summary"><p>Gets an int from the ini.</p>
  233. </div>
  234. <div class="markdown level1 conceptual"></div>
  235. <h5 class="decalaration">Declaration</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false)</code></pre>
  238. </div>
  239. <h5 class="parameters">Parameters</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Type</th>
  244. <th>Name</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  251. <td><span class="parametername">section</span></td>
  252. <td><p>Section of the key.</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  257. <td><span class="parametername">name</span></td>
  258. <td><p>Name of the key.</p>
  259. </td>
  260. </tr>
  261. <tr>
  262. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
  263. <td><span class="parametername">defaultValue</span></td>
  264. <td><p>Value that should be used when no value is found.</p>
  265. </td>
  266. </tr>
  267. <tr>
  268. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  269. <td><span class="parametername">autoSave</span></td>
  270. <td><p>Whether or not the default value should be written if no value is found.</p>
  271. </td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <h5 class="returns">Returns</h5>
  276. <table class="table table-bordered table-striped table-condensed">
  277. <thead>
  278. <tr>
  279. <th>Type</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
  286. <td></td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <span class="small pull-right mobile-hide">
  291. <span class="divider">|</span>
  292. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  293. </span>
  294. <span class="small pull-right mobile-hide">
  295. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L25">View Source</a>
  296. </span>
  297. <a id="IPA_Config_IModPrefs_GetString_" data-uid="IPA.Config.IModPrefs.GetString*"></a>
  298. <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>
  299. <div class="markdown level1 summary"><p>Gets a string from the ini.</p>
  300. </div>
  301. <div class="markdown level1 conceptual"></div>
  302. <h5 class="decalaration">Declaration</h5>
  303. <div class="codewrapper">
  304. <pre><code class="lang-csharp hljs">string GetString(string section, string name, string defaultValue = &quot;&quot;, bool autoSave = false)</code></pre>
  305. </div>
  306. <h5 class="parameters">Parameters</h5>
  307. <table class="table table-bordered table-striped table-condensed">
  308. <thead>
  309. <tr>
  310. <th>Type</th>
  311. <th>Name</th>
  312. <th>Description</th>
  313. </tr>
  314. </thead>
  315. <tbody>
  316. <tr>
  317. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  318. <td><span class="parametername">section</span></td>
  319. <td><p>Section of the key.</p>
  320. </td>
  321. </tr>
  322. <tr>
  323. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  324. <td><span class="parametername">name</span></td>
  325. <td><p>Name of the key.</p>
  326. </td>
  327. </tr>
  328. <tr>
  329. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  330. <td><span class="parametername">defaultValue</span></td>
  331. <td><p>Value that should be used when no value is found.</p>
  332. </td>
  333. </tr>
  334. <tr>
  335. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  336. <td><span class="parametername">autoSave</span></td>
  337. <td><p>Whether or not the default value should be written if no value is found.</p>
  338. </td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. <h5 class="returns">Returns</h5>
  343. <table class="table table-bordered table-striped table-condensed">
  344. <thead>
  345. <tr>
  346. <th>Type</th>
  347. <th>Description</th>
  348. </tr>
  349. </thead>
  350. <tbody>
  351. <tr>
  352. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  353. <td></td>
  354. </tr>
  355. </tbody>
  356. </table>
  357. <span class="small pull-right mobile-hide">
  358. <span class="divider">|</span>
  359. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  360. </span>
  361. <span class="small pull-right mobile-hide">
  362. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L59">View Source</a>
  363. </span>
  364. <a id="IPA_Config_IModPrefs_HasKey_" data-uid="IPA.Config.IModPrefs.HasKey*"></a>
  365. <h4 id="IPA_Config_IModPrefs_HasKey_System_String_System_String_" data-uid="IPA.Config.IModPrefs.HasKey(System.String,System.String)">HasKey(String, String)</h4>
  366. <div class="markdown level1 summary"><p>Checks whether or not a key exists in the ini.</p>
  367. </div>
  368. <div class="markdown level1 conceptual"></div>
  369. <h5 class="decalaration">Declaration</h5>
  370. <div class="codewrapper">
  371. <pre><code class="lang-csharp hljs">bool HasKey(string section, string name)</code></pre>
  372. </div>
  373. <h5 class="parameters">Parameters</h5>
  374. <table class="table table-bordered table-striped table-condensed">
  375. <thead>
  376. <tr>
  377. <th>Type</th>
  378. <th>Name</th>
  379. <th>Description</th>
  380. </tr>
  381. </thead>
  382. <tbody>
  383. <tr>
  384. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  385. <td><span class="parametername">section</span></td>
  386. <td><p>Section of the key.</p>
  387. </td>
  388. </tr>
  389. <tr>
  390. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  391. <td><span class="parametername">name</span></td>
  392. <td><p>Name of the key.</p>
  393. </td>
  394. </tr>
  395. </tbody>
  396. </table>
  397. <h5 class="returns">Returns</h5>
  398. <table class="table table-bordered table-striped table-condensed">
  399. <thead>
  400. <tr>
  401. <th>Type</th>
  402. <th>Description</th>
  403. </tr>
  404. </thead>
  405. <tbody>
  406. <tr>
  407. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  408. <td></td>
  409. </tr>
  410. </tbody>
  411. </table>
  412. <span class="small pull-right mobile-hide">
  413. <span class="divider">|</span>
  414. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  415. </span>
  416. <span class="small pull-right mobile-hide">
  417. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L87">View Source</a>
  418. </span>
  419. <a id="IPA_Config_IModPrefs_SetBool_" data-uid="IPA.Config.IModPrefs.SetBool*"></a>
  420. <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>
  421. <div class="markdown level1 summary"><p>Sets a bool in the ini.</p>
  422. </div>
  423. <div class="markdown level1 conceptual"></div>
  424. <h5 class="decalaration">Declaration</h5>
  425. <div class="codewrapper">
  426. <pre><code class="lang-csharp hljs">void SetBool(string section, string name, bool value)</code></pre>
  427. </div>
  428. <h5 class="parameters">Parameters</h5>
  429. <table class="table table-bordered table-striped table-condensed">
  430. <thead>
  431. <tr>
  432. <th>Type</th>
  433. <th>Name</th>
  434. <th>Description</th>
  435. </tr>
  436. </thead>
  437. <tbody>
  438. <tr>
  439. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  440. <td><span class="parametername">section</span></td>
  441. <td><p>Section of the key.</p>
  442. </td>
  443. </tr>
  444. <tr>
  445. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  446. <td><span class="parametername">name</span></td>
  447. <td><p>Name of the key.</p>
  448. </td>
  449. </tr>
  450. <tr>
  451. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  452. <td><span class="parametername">value</span></td>
  453. <td><p>Value that should be written.</p>
  454. </td>
  455. </tr>
  456. </tbody>
  457. </table>
  458. <span class="small pull-right mobile-hide">
  459. <span class="divider">|</span>
  460. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  461. </span>
  462. <span class="small pull-right mobile-hide">
  463. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L66">View Source</a>
  464. </span>
  465. <a id="IPA_Config_IModPrefs_SetFloat_" data-uid="IPA.Config.IModPrefs.SetFloat*"></a>
  466. <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>
  467. <div class="markdown level1 summary"><p>Sets a float in the ini.</p>
  468. </div>
  469. <div class="markdown level1 conceptual"></div>
  470. <h5 class="decalaration">Declaration</h5>
  471. <div class="codewrapper">
  472. <pre><code class="lang-csharp hljs">void SetFloat(string section, string name, float value)</code></pre>
  473. </div>
  474. <h5 class="parameters">Parameters</h5>
  475. <table class="table table-bordered table-striped table-condensed">
  476. <thead>
  477. <tr>
  478. <th>Type</th>
  479. <th>Name</th>
  480. <th>Description</th>
  481. </tr>
  482. </thead>
  483. <tbody>
  484. <tr>
  485. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  486. <td><span class="parametername">section</span></td>
  487. <td><p>Section of the key.</p>
  488. </td>
  489. </tr>
  490. <tr>
  491. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  492. <td><span class="parametername">name</span></td>
  493. <td><p>Name of the key.</p>
  494. </td>
  495. </tr>
  496. <tr>
  497. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.single">Single</a></td>
  498. <td><span class="parametername">value</span></td>
  499. <td><p>Value that should be written.</p>
  500. </td>
  501. </tr>
  502. </tbody>
  503. </table>
  504. <span class="small pull-right mobile-hide">
  505. <span class="divider">|</span>
  506. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  507. </span>
  508. <span class="small pull-right mobile-hide">
  509. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L73">View Source</a>
  510. </span>
  511. <a id="IPA_Config_IModPrefs_SetInt_" data-uid="IPA.Config.IModPrefs.SetInt*"></a>
  512. <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>
  513. <div class="markdown level1 summary"><p>Sets an int in the ini.</p>
  514. </div>
  515. <div class="markdown level1 conceptual"></div>
  516. <h5 class="decalaration">Declaration</h5>
  517. <div class="codewrapper">
  518. <pre><code class="lang-csharp hljs">void SetInt(string section, string name, int value)</code></pre>
  519. </div>
  520. <h5 class="parameters">Parameters</h5>
  521. <table class="table table-bordered table-striped table-condensed">
  522. <thead>
  523. <tr>
  524. <th>Type</th>
  525. <th>Name</th>
  526. <th>Description</th>
  527. </tr>
  528. </thead>
  529. <tbody>
  530. <tr>
  531. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  532. <td><span class="parametername">section</span></td>
  533. <td><p>Section of the key.</p>
  534. </td>
  535. </tr>
  536. <tr>
  537. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  538. <td><span class="parametername">name</span></td>
  539. <td><p>Name of the key.</p>
  540. </td>
  541. </tr>
  542. <tr>
  543. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
  544. <td><span class="parametername">value</span></td>
  545. <td><p>Value that should be written.</p>
  546. </td>
  547. </tr>
  548. </tbody>
  549. </table>
  550. <span class="small pull-right mobile-hide">
  551. <span class="divider">|</span>
  552. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  553. </span>
  554. <span class="small pull-right mobile-hide">
  555. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L80">View Source</a>
  556. </span>
  557. <a id="IPA_Config_IModPrefs_SetString_" data-uid="IPA.Config.IModPrefs.SetString*"></a>
  558. <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>
  559. <div class="markdown level1 summary"><p>Sets a string in the ini.</p>
  560. </div>
  561. <div class="markdown level1 conceptual"></div>
  562. <h5 class="decalaration">Declaration</h5>
  563. <div class="codewrapper">
  564. <pre><code class="lang-csharp hljs">void SetString(string section, string name, string value)</code></pre>
  565. </div>
  566. <h5 class="parameters">Parameters</h5>
  567. <table class="table table-bordered table-striped table-condensed">
  568. <thead>
  569. <tr>
  570. <th>Type</th>
  571. <th>Name</th>
  572. <th>Description</th>
  573. </tr>
  574. </thead>
  575. <tbody>
  576. <tr>
  577. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  578. <td><span class="parametername">section</span></td>
  579. <td><p>Section of the key.</p>
  580. </td>
  581. </tr>
  582. <tr>
  583. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  584. <td><span class="parametername">name</span></td>
  585. <td><p>Name of the key.</p>
  586. </td>
  587. </tr>
  588. <tr>
  589. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  590. <td><span class="parametername">value</span></td>
  591. <td><p>Value that should be written.</p>
  592. </td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <h3 id="extensionmethods">Extension Methods</h3>
  597. <div>
  598. <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>
  599. </div>
  600. <div>
  601. <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>
  602. </div>
  603. <div>
  604. <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>
  605. </div>
  606. <div>
  607. <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>
  608. </div>
  609. <div>
  610. <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>
  611. </div>
  612. </article>
  613. </div>
  614. <div class="hidden-sm col-md-2" role="complementary">
  615. <div class="sideaffix">
  616. <div class="contribution">
  617. <ul class="nav">
  618. <li>
  619. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  620. </li>
  621. <li>
  622. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Config/ModPrefs.cs/#L14" class="contribution-link">View Source</a>
  623. </li>
  624. </ul>
  625. </div>
  626. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  627. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  628. </nav>
  629. </div>
  630. </div>
  631. </div>
  632. </div>
  633. <footer>
  634. <div class="grad-bottom"></div>
  635. <div class="footer">
  636. <div class="container">
  637. <span class="pull-right">
  638. <a href="#top">Back to top</a>
  639. </span>
  640. <span>Generated by <strong>DocFX</strong></span>
  641. </div>
  642. </div>
  643. </footer>
  644. </div>
  645. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  646. <script type="text/javascript" src="../styles/docfx.js"></script>
  647. <script type="text/javascript" src="../styles/main.js"></script>
  648. </body>
  649. </html>