expvintl/RAGECOOP-V
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
RAGECOOP-V/docs/api/RageCoop.Client.Settings.html

503 lines
18 KiB
HTML
Raw Normal View History

Add docfx documentation
2022-07-01 17:00:42 +08:00
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Settings
| RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Settings
| RageCoop resource documentation ">
<meta name="generator" content="docfx 2.59.2.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">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</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">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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="RageCoop.Client.Settings">
<h1 id="RageCoop_Client_Settings" data-uid="RageCoop.Client.Settings" class="text-break">Class Settings
</h1>
<div class="markdown level0 summary"><p>Don't use it!</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">Settings</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="RageCoop.Client.html">RageCoop.Client</a></h6>
<h6><strong>Assembly</strong>: RageCoop.Client.dll</h6>
<h5 id="RageCoop_Client_Settings_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Settings</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<h4 id="RageCoop_Client_Settings_LogLevel" data-uid="RageCoop.Client.Settings.LogLevel">LogLevel</h4>
<div class="markdown level1 summary"><p>LogLevel for RageCoop.
0:Trace, 1:Debug, 2:Info, 3:Warning, 4:Error</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LogLevel</code></pre>
</div>
<h5 class="fieldValue">Field Value</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>
<h3 id="properties">Properties
</h3>
Update documentation
2022-07-02 18:04:07 +08:00
<a id="RageCoop_Client_Settings_DataDirectory_" data-uid="RageCoop.Client.Settings.DataDirectory*"></a>
<h4 id="RageCoop_Client_Settings_DataDirectory" data-uid="RageCoop.Client.Settings.DataDirectory">DataDirectory</h4>
<div class="markdown level1 summary"><p>The directory where log and resources downloaded from server will be placed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string DataDirectory { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
Add docfx documentation
2022-07-01 17:00:42 +08:00
<a id="RageCoop_Client_Settings_DisableAlternatePause_" data-uid="RageCoop.Client.Settings.DisableAlternatePause*"></a>
<h4 id="RageCoop_Client_Settings_DisableAlternatePause" data-uid="RageCoop.Client.Settings.DisableAlternatePause">DisableAlternatePause</h4>
<div class="markdown level1 summary"><p>Bring up pause menu but don't freeze time when FrontEndPauseAlternate(Esc) is pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool DisableAlternatePause { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_DisableTraffic_" data-uid="RageCoop.Client.Settings.DisableTraffic*"></a>
<h4 id="RageCoop_Client_Settings_DisableTraffic" data-uid="RageCoop.Client.Settings.DisableTraffic">DisableTraffic</h4>
<div class="markdown level1 summary"><p>Disable world NPC traffic, mission entities won't be affected</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool DisableTraffic { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_FlipMenu_" data-uid="RageCoop.Client.Settings.FlipMenu*"></a>
<h4 id="RageCoop_Client_Settings_FlipMenu" data-uid="RageCoop.Client.Settings.FlipMenu">FlipMenu</h4>
<div class="markdown level1 summary"><p>Don't use it!</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool FlipMenu { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_LastServerAddress_" data-uid="RageCoop.Client.Settings.LastServerAddress*"></a>
<h4 id="RageCoop_Client_Settings_LastServerAddress" data-uid="RageCoop.Client.Settings.LastServerAddress">LastServerAddress</h4>
<div class="markdown level1 summary"><p>Don't use it!</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string LastServerAddress { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_MasterServer_" data-uid="RageCoop.Client.Settings.MasterServer*"></a>
<h4 id="RageCoop_Client_Settings_MasterServer" data-uid="RageCoop.Client.Settings.MasterServer">MasterServer</h4>
<div class="markdown level1 summary"><p>Don't use it!</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string MasterServer { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_MenuKey_" data-uid="RageCoop.Client.Settings.MenuKey*"></a>
<h4 id="RageCoop_Client_Settings_MenuKey" data-uid="RageCoop.Client.Settings.MenuKey">MenuKey</h4>
<div class="markdown level1 summary"><p>The key to open menu</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Keys MenuKey { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.windows.forms.keys">Keys</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Client_Settings_PassengerKey_" data-uid="RageCoop.Client.Settings.PassengerKey*"></a>
<h4 id="RageCoop_Client_Settings_PassengerKey" data-uid="RageCoop.Client.Settings.PassengerKey">PassengerKey</h4>
<div class="markdown level1 summary"><p>The key to enter a vehicle as passenger.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Keys PassengerKey { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.windows.forms.keys">Keys</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Client_Settings_Password_" data-uid="RageCoop.Client.Settings.Password*"></a>
<h4 id="RageCoop_Client_Settings_Password" data-uid="RageCoop.Client.Settings.Password">Password</h4>
<div class="markdown level1 summary"><p>The password used to authenticate when connecting to a server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Password { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_Username_" data-uid="RageCoop.Client.Settings.Username*"></a>
<h4 id="RageCoop_Client_Settings_Username" data-uid="RageCoop.Client.Settings.Username">Username</h4>
<div class="markdown level1 summary"><p>Don't use it!</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Username { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_WorldPedSoftLimit_" data-uid="RageCoop.Client.Settings.WorldPedSoftLimit*"></a>
<h4 id="RageCoop_Client_Settings_WorldPedSoftLimit" data-uid="RageCoop.Client.Settings.WorldPedSoftLimit">WorldPedSoftLimit</h4>
<div class="markdown level1 summary"><p>The game won't spawn more NPC traffic if the limit is exceeded. -1 for unlimited (not recommended).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int WorldPedSoftLimit { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<a id="RageCoop_Client_Settings_WorldVehicleSoftLimit_" data-uid="RageCoop.Client.Settings.WorldVehicleSoftLimit*"></a>
<h4 id="RageCoop_Client_Settings_WorldVehicleSoftLimit" data-uid="RageCoop.Client.Settings.WorldVehicleSoftLimit">WorldVehicleSoftLimit</h4>
<div class="markdown level1 summary"><p>The game won't spawn more NPC traffic if the limit is exceeded. -1 for unlimited (not recommended).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int WorldVehicleSoftLimit { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</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>
Reference in New Issue Copy Permalink