fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
10.4 KiB228 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>SettingsDescriptionFieldJson | 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="settingsdescriptionfieldjson.html">SettingsDescriptionFieldJson</a>
60				</li>
61			</ul>
62			<h1>Interface SettingsDescriptionFieldJson</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 Field describes a single setting by its name and its current value.</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">SettingsDescriptionFieldJson</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="settingsdescriptionfieldjson.html#text" class="tsd-kind-icon">text</a></li>
92								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="settingsdescriptionfieldjson.html#value" class="tsd-kind-icon">value</a></li>
93							</ul>
94						</section>
95					</div>
96				</section>
97			</section>
98			<section class="tsd-panel-group tsd-member-group ">
99				<h2>Properties</h2>
100				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
101					<a name="text" class="tsd-anchor"></a>
102					<h3>text</h3>
103					<div class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104					<aside class="tsd-sources">
105						<ul>
106							<li>Defined in livesplit_core.ts:553</li>
107						</ul>
108					</aside>
109					<div class="tsd-comment tsd-typography">
110						<div class="lead">
111							<p>The name of the setting.</p>
112						</div>
113					</div>
114				</section>
115				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116					<a name="value" class="tsd-anchor"></a>
117					<h3>value</h3>
118					<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <a href="../globals.html#settingsdescriptionvaluejson" class="tsd-signature-type">SettingsDescriptionValueJson</a></div>
119					<aside class="tsd-sources">
120						<ul>
121							<li>Defined in livesplit_core.ts:555</li>
122						</ul>
123					</aside>
124					<div class="tsd-comment tsd-typography">
125						<div class="lead">
126							<p>The current value of the setting.</p>
127						</div>
128					</div>
129				</section>
130			</section>
131		</div>
132		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
133			<nav class="tsd-navigation primary">
134				<ul>
135					<li class="globals  ">
136						<a href="../globals.html"><em>Globals</em></a>
137					</li>
138				</ul>
139			</nav>
140			<nav class="tsd-navigation secondary menu-sticky">
141				<ul class="before-current">
142				</ul>
143				<ul class="current">
144					<li class="current tsd-kind-interface">
145						<a href="settingsdescriptionfieldjson.html" class="tsd-kind-icon">Settings<wbr>Description<wbr>Field<wbr>Json</a>
146						<ul>
147							<li class=" tsd-kind-property tsd-parent-kind-interface">
148								<a href="settingsdescriptionfieldjson.html#text" class="tsd-kind-icon">text</a>
149							</li>
150							<li class=" tsd-kind-property tsd-parent-kind-interface">
151								<a href="settingsdescriptionfieldjson.html#value" class="tsd-kind-icon">value</a>
152							</li>
153						</ul>
154					</li>
155				</ul>
156				<ul class="after-current">
157				</ul>
158			</nav>
159		</div>
160	</div>
161</div>
162<footer class="with-border-bottom">
163	<div class="container">
164		<h2>Legend</h2>
165		<div class="tsd-legend-group">
166			<ul class="tsd-legend">
167				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
168				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
169				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
170				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
171				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
172				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
173				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
174			</ul>
175			<ul class="tsd-legend">
176				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
177				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
178				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
179				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
180			</ul>
181			<ul class="tsd-legend">
182				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
183				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
184				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
185				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
186				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
187				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
188			</ul>
189			<ul class="tsd-legend">
190				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
191				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
192				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
193				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
194				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
195				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
196				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
197			</ul>
198			<ul class="tsd-legend">
199				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
200				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
201				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
202				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
203			</ul>
204			<ul class="tsd-legend">
205				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
206				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
207				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
208			</ul>
209			<ul class="tsd-legend">
210				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
211				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
212				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
213			</ul>
214			<ul class="tsd-legend">
215				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
216				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
217			</ul>
218		</div>
219	</div>
220</footer>
221<div class="container tsd-generator">
222	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
223</div>
224<div class="overlay"></div>
225<script src="../assets/js/main.js"></script>
226<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
227</body>
228</html>