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
663 lines
31 KiB
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Interface IModPrefs
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Interface IModPrefs
|
|
">
|
|
<meta name="generator" content="docfx 2.48.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<link rel="stylesheet" href="../styles/fix.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
<meta property="docfx:newtab" content="true">
|
|
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list"></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="IPA.Config.IModPrefs">
|
|
|
|
|
|
<h1 id="IPA_Config_IModPrefs" data-uid="IPA.Config.IModPrefs" class="text-break">Interface IModPrefs
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Allows to get and set preferences for your mod. </p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
|
|
<h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
|
|
<h5 id="IPA_Config_IModPrefs_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.")]
|
|
public interface IModPrefs</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L52">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_GetBool_" data-uid="IPA.Config.IModPrefs.GetBool*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Gets a bool from the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">defaultValue</span></td>
|
|
<td><p>Value that should be used when no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">autoSave</span></td>
|
|
<td><p>Whether or not the default value should be written if no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L43">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_GetFloat_" data-uid="IPA.Config.IModPrefs.GetFloat*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Gets a float from the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.single">Single</a></td>
|
|
<td><span class="parametername">defaultValue</span></td>
|
|
<td><p>Value that should be used when no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">autoSave</span></td>
|
|
<td><p>Whether or not the default value should be written if no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.single">Single</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L34">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_GetInt_" data-uid="IPA.Config.IModPrefs.GetInt*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Gets an int from the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
|
|
<td><span class="parametername">defaultValue</span></td>
|
|
<td><p>Value that should be used when no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">autoSave</span></td>
|
|
<td><p>Whether or not the default value should be written if no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L25">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_GetString_" data-uid="IPA.Config.IModPrefs.GetString*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Gets a string from the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">string GetString(string section, string name, string defaultValue = "", bool autoSave = false)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">defaultValue</span></td>
|
|
<td><p>Value that should be used when no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">autoSave</span></td>
|
|
<td><p>Whether or not the default value should be written if no value is found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L59">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_HasKey_" data-uid="IPA.Config.IModPrefs.HasKey*"></a>
|
|
<h4 id="IPA_Config_IModPrefs_HasKey_System_String_System_String_" data-uid="IPA.Config.IModPrefs.HasKey(System.String,System.String)">HasKey(String, String)</h4>
|
|
<div class="markdown level1 summary"><p>Checks whether or not a key exists in the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">bool HasKey(string section, string name)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L87">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_SetBool_" data-uid="IPA.Config.IModPrefs.SetBool*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Sets a bool in the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">void SetBool(string section, string name, bool value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>Value that should be written.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L66">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_SetFloat_" data-uid="IPA.Config.IModPrefs.SetFloat*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Sets a float in the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">void SetFloat(string section, string name, float value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.single">Single</a></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>Value that should be written.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L73">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_SetInt_" data-uid="IPA.Config.IModPrefs.SetInt*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Sets an int in the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">void SetInt(string section, string name, int value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>Value that should be written.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<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&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L80">View Source</a>
|
|
</span>
|
|
<a id="IPA_Config_IModPrefs_SetString_" data-uid="IPA.Config.IModPrefs.SetString*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Sets a string in the ini.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">void SetString(string section, string name, string value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">section</span></td>
|
|
<td><p>Section of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>Name of the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>Value that should be written.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="extensionmethods">Extension Methods</h3>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod<U, T>(T, String, Object[])</a>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_IModPrefs.md&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>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/18d0824f89dd336b9ff8d97352646c6c8f9c41a8/IPA.Loader/Config/ModPrefs.cs/#L14" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|