fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
11.2 KiB250 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>SettingValueRef | 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="settingvalueref.html">SettingValueRef</a>
60				</li>
61			</ul>
62			<h1>Class SettingValueRef</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>Describes a setting&#39;s value. Such a value can be of a variety of different
73						types.</p>
74					</div>
75				</div>
76			</section>
77			<section class="tsd-panel tsd-hierarchy">
78				<h3>Hierarchy</h3>
79				<ul class="tsd-hierarchy">
80					<li>
81						<span class="target">SettingValueRef</span>
82						<ul class="tsd-hierarchy">
83							<li>
84								<a href="settingvaluerefmut.html" class="tsd-signature-type">SettingValueRefMut</a>
85							</li>
86						</ul>
87					</li>
88				</ul>
89			</section>
90			<section class="tsd-panel-group tsd-index-group">
91				<h2>Index</h2>
92				<section class="tsd-panel tsd-index-panel">
93					<div class="tsd-index-content">
94						<section class="tsd-index-section ">
95							<h3>Constructors</h3>
96							<ul class="tsd-index-list">
97								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="settingvalueref.html#constructor" class="tsd-kind-icon">constructor</a></li>
98							</ul>
99						</section>
100						<section class="tsd-index-section ">
101							<h3>Properties</h3>
102							<ul class="tsd-index-list">
103								<li class="tsd-kind-property tsd-parent-kind-class"><a href="settingvalueref.html#ptr" class="tsd-kind-icon">ptr</a></li>
104							</ul>
105						</section>
106					</div>
107				</section>
108			</section>
109			<section class="tsd-panel-group tsd-member-group ">
110				<h2>Constructors</h2>
111				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
112					<a name="constructor" class="tsd-anchor"></a>
113					<h3>constructor</h3>
114					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
115						<li class="tsd-signature tsd-kind-icon">new <wbr>Setting<wbr>Value<wbr>Ref<span class="tsd-signature-symbol">(</span>ptr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="settingvalueref.html" class="tsd-signature-type">SettingValueRef</a></li>
116					</ul>
117					<ul class="tsd-descriptions">
118						<li class="tsd-description">
119							<aside class="tsd-sources">
120								<ul>
121									<li>Defined in livesplit_core.ts:5437</li>
122								</ul>
123							</aside>
124							<div class="tsd-comment tsd-typography">
125								<div class="lead">
126									<p>This constructor is an implementation detail. Do not use this.</p>
127								</div>
128							</div>
129							<h4 class="tsd-parameters-title">Parameters</h4>
130							<ul class="tsd-parameters">
131								<li>
132									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
133								</li>
134							</ul>
135							<h4 class="tsd-returns-title">Returns <a href="settingvalueref.html" class="tsd-signature-type">SettingValueRef</a></h4>
136						</li>
137					</ul>
138				</section>
139			</section>
140			<section class="tsd-panel-group tsd-member-group ">
141				<h2>Properties</h2>
142				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
143					<a name="ptr" class="tsd-anchor"></a>
144					<h3>ptr</h3>
145					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
146					<aside class="tsd-sources">
147						<ul>
148							<li>Defined in livesplit_core.ts:5437</li>
149						</ul>
150					</aside>
151				</section>
152			</section>
153		</div>
154		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
155			<nav class="tsd-navigation primary">
156				<ul>
157					<li class="globals  ">
158						<a href="../globals.html"><em>Globals</em></a>
159					</li>
160				</ul>
161			</nav>
162			<nav class="tsd-navigation secondary menu-sticky">
163				<ul class="before-current">
164				</ul>
165				<ul class="current">
166					<li class="current tsd-kind-class">
167						<a href="settingvalueref.html" class="tsd-kind-icon">Setting<wbr>Value<wbr>Ref</a>
168						<ul>
169							<li class=" tsd-kind-constructor tsd-parent-kind-class">
170								<a href="settingvalueref.html#constructor" class="tsd-kind-icon">constructor</a>
171							</li>
172							<li class=" tsd-kind-property tsd-parent-kind-class">
173								<a href="settingvalueref.html#ptr" class="tsd-kind-icon">ptr</a>
174							</li>
175						</ul>
176					</li>
177				</ul>
178				<ul class="after-current">
179				</ul>
180			</nav>
181		</div>
182	</div>
183</div>
184<footer class="with-border-bottom">
185	<div class="container">
186		<h2>Legend</h2>
187		<div class="tsd-legend-group">
188			<ul class="tsd-legend">
189				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
190				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
191				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
192				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
193				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
194				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
195				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
196			</ul>
197			<ul class="tsd-legend">
198				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
199				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
200				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
201				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
202			</ul>
203			<ul class="tsd-legend">
204				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
205				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
206				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
207				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
208				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
209				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
210			</ul>
211			<ul class="tsd-legend">
212				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
213				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
214				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
215				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
216				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
217				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
218				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
219			</ul>
220			<ul class="tsd-legend">
221				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
222				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
223				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
224				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
225			</ul>
226			<ul class="tsd-legend">
227				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
228				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
229				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
230			</ul>
231			<ul class="tsd-legend">
232				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
233				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
234				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
235			</ul>
236			<ul class="tsd-legend">
237				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
238				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
239			</ul>
240		</div>
241	</div>
242</footer>
243<div class="container tsd-generator">
244	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
245</div>
246<div class="overlay"></div>
247<script src="../assets/js/main.js"></script>
248<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
249</body>
250</html>