fork/livesplit-core

git clone https://git.julia.blue/fork/livesplit-core

Christopher SerrAdd docsee16b86

v0.11.0
9.6 KiB210 linesraw
1<!doctype html>
2<html class="default no-js">
3<head>
4	<meta charset="utf-8">
5	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6	<title>SettingsDescriptionJson | livesplit</title>
7	<meta name="description" content="">
8	<meta name="viewport" content="width=device-width, initial-scale=1">
9	<link rel="stylesheet" href="../assets/css/main.css">
10</head>
11<body>
12<header>
13	<div class="tsd-page-toolbar">
14		<div class="container">
15			<div class="table-wrap">
16				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17					<div class="field">
18						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19						<input id="tsd-search-field" type="text" />
20					</div>
21					<ul class="results">
22						<li class="state loading">Preparing search index...</li>
23						<li class="state failure">The search index is not available</li>
24					</ul>
25					<a href="../index.html" class="title">livesplit</a>
26				</div>
27				<div class="table-cell" id="tsd-widgets">
28					<div id="tsd-filter">
29						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30						<div class="tsd-filter-group">
31							<div class="tsd-select" id="tsd-filter-visibility">
32								<span class="tsd-select-label">All</span>
33								<ul class="tsd-select-list">
34									<li data-value="public">Public</li>
35									<li data-value="protected">Public/Protected</li>
36									<li data-value="private" class="selected">All</li>
37								</ul>
38							</div>
39							<input type="checkbox" id="tsd-filter-inherited" checked />
40							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41							<input type="checkbox" id="tsd-filter-externals" checked />
42							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43							<input type="checkbox" id="tsd-filter-only-exported" />
44							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45						</div>
46					</div>
47					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48				</div>
49			</div>
50		</div>
51	</div>
52	<div class="tsd-page-title">
53		<div class="container">
54			<ul class="tsd-breadcrumb">
55				<li>
56					<a href="../globals.html">Globals</a>
57				</li>
58				<li>
59					<a href="settingsdescriptionjson.html">SettingsDescriptionJson</a>
60				</li>
61			</ul>
62			<h1>Interface SettingsDescriptionJson</h1>
63		</div>
64	</div>
65</header>
66<div class="container container-main">
67	<div class="row">
68		<div class="col-8 col-content">
69			<section class="tsd-panel tsd-comment">
70				<div class="tsd-comment tsd-typography">
71					<div class="lead">
72						<p>A generic description of the settings available and their current values.</p>
73					</div>
74				</div>
75			</section>
76			<section class="tsd-panel tsd-hierarchy">
77				<h3>Hierarchy</h3>
78				<ul class="tsd-hierarchy">
79					<li>
80						<span class="target">SettingsDescriptionJson</span>
81					</li>
82				</ul>
83			</section>
84			<section class="tsd-panel-group tsd-index-group">
85				<h2>Index</h2>
86				<section class="tsd-panel tsd-index-panel">
87					<div class="tsd-index-content">
88						<section class="tsd-index-section ">
89							<h3>Properties</h3>
90							<ul class="tsd-index-list">
91								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="settingsdescriptionjson.html#fields" class="tsd-kind-icon">fields</a></li>
92							</ul>
93						</section>
94					</div>
95				</section>
96			</section>
97			<section class="tsd-panel-group tsd-member-group ">
98				<h2>Properties</h2>
99				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
100					<a name="fields" class="tsd-anchor"></a>
101					<h3>fields</h3>
102					<div class="tsd-signature tsd-kind-icon">fields<span class="tsd-signature-symbol">:</span> <a href="settingsdescriptionfieldjson.html" class="tsd-signature-type">SettingsDescriptionFieldJson</a><span class="tsd-signature-symbol">[]</span></div>
103					<aside class="tsd-sources">
104						<ul>
105							<li>Defined in livesplit_core.ts:547</li>
106						</ul>
107					</aside>
108					<div class="tsd-comment tsd-typography">
109						<div class="lead">
110							<p>All of the different settings that are available and their current
111							values.</p>
112						</div>
113					</div>
114				</section>
115			</section>
116		</div>
117		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
118			<nav class="tsd-navigation primary">
119				<ul>
120					<li class="globals  ">
121						<a href="../globals.html"><em>Globals</em></a>
122					</li>
123				</ul>
124			</nav>
125			<nav class="tsd-navigation secondary menu-sticky">
126				<ul class="before-current">
127				</ul>
128				<ul class="current">
129					<li class="current tsd-kind-interface">
130						<a href="settingsdescriptionjson.html" class="tsd-kind-icon">Settings<wbr>Description<wbr>Json</a>
131						<ul>
132							<li class=" tsd-kind-property tsd-parent-kind-interface">
133								<a href="settingsdescriptionjson.html#fields" class="tsd-kind-icon">fields</a>
134							</li>
135						</ul>
136					</li>
137				</ul>
138				<ul class="after-current">
139				</ul>
140			</nav>
141		</div>
142	</div>
143</div>
144<footer class="with-border-bottom">
145	<div class="container">
146		<h2>Legend</h2>
147		<div class="tsd-legend-group">
148			<ul class="tsd-legend">
149				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
150				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
151				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
152				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
153				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
154				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
155				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
156			</ul>
157			<ul class="tsd-legend">
158				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
159				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
160				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
161				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
162			</ul>
163			<ul class="tsd-legend">
164				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
165				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
166				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
167				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
168				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
169				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
170			</ul>
171			<ul class="tsd-legend">
172				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
173				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
174				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
175				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
176				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
177				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
178				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
179			</ul>
180			<ul class="tsd-legend">
181				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
182				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
183				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
184				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
185			</ul>
186			<ul class="tsd-legend">
187				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
188				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
189				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
190			</ul>
191			<ul class="tsd-legend">
192				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
193				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
194				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
195			</ul>
196			<ul class="tsd-legend">
197				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
198				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
199			</ul>
200		</div>
201	</div>
202</footer>
203<div class="container tsd-generator">
204	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
205</div>
206<div class="overlay"></div>
207<script src="../assets/js/main.js"></script>
208<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
209</body>
210</html>