fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
16.1 KiB336 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>DeltaComponentRefMut | 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="deltacomponentrefmut.html">DeltaComponentRefMut</a>
60				</li>
61			</ul>
62			<h1>Class DeltaComponentRefMut</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>The Delta Component is a component that shows the how far ahead or behind
73						the current attempt is compared to the chosen comparison.</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						<a href="deltacomponentref.html" class="tsd-signature-type">DeltaComponentRef</a>
82						<ul class="tsd-hierarchy">
83							<li>
84								<span class="target">DeltaComponentRefMut</span>
85								<ul class="tsd-hierarchy">
86									<li>
87										<a href="deltacomponent.html" class="tsd-signature-type">DeltaComponent</a>
88									</li>
89								</ul>
90							</li>
91						</ul>
92					</li>
93				</ul>
94			</section>
95			<section class="tsd-panel-group tsd-index-group">
96				<h2>Index</h2>
97				<section class="tsd-panel tsd-index-panel">
98					<div class="tsd-index-content">
99						<section class="tsd-index-section tsd-is-inherited">
100							<h3>Constructors</h3>
101							<ul class="tsd-index-list">
102								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="deltacomponentrefmut.html#constructor" class="tsd-kind-icon">constructor</a></li>
103							</ul>
104						</section>
105						<section class="tsd-index-section tsd-is-inherited">
106							<h3>Properties</h3>
107							<ul class="tsd-index-list">
108								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="deltacomponentrefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
109							</ul>
110						</section>
111						<section class="tsd-index-section ">
112							<h3>Methods</h3>
113							<ul class="tsd-index-list">
114								<li class="tsd-kind-method tsd-parent-kind-class"><a href="deltacomponentrefmut.html#state" class="tsd-kind-icon">state</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class"><a href="deltacomponentrefmut.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a></li>
116							</ul>
117						</section>
118					</div>
119				</section>
120			</section>
121			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
122				<h2>Constructors</h2>
123				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
124					<a name="constructor" class="tsd-anchor"></a>
125					<h3>constructor</h3>
126					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
127						<li class="tsd-signature tsd-kind-icon">new <wbr>Delta<wbr>Component<wbr>Ref<wbr>Mut<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="deltacomponentrefmut.html" class="tsd-signature-type">DeltaComponentRefMut</a></li>
128					</ul>
129					<ul class="tsd-descriptions">
130						<li class="tsd-description">
131							<aside class="tsd-sources">
132								<p>Inherited from <a href="deltacomponentref.html">DeltaComponentRef</a>.<a href="deltacomponentref.html#constructor">constructor</a></p>
133								<ul>
134									<li>Defined in livesplit_core.ts:1990</li>
135								</ul>
136							</aside>
137							<div class="tsd-comment tsd-typography">
138								<div class="lead">
139									<p>This constructor is an implementation detail. Do not use this.</p>
140								</div>
141							</div>
142							<h4 class="tsd-parameters-title">Parameters</h4>
143							<ul class="tsd-parameters">
144								<li>
145									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
146								</li>
147							</ul>
148							<h4 class="tsd-returns-title">Returns <a href="deltacomponentrefmut.html" class="tsd-signature-type">DeltaComponentRefMut</a></h4>
149						</li>
150					</ul>
151				</section>
152			</section>
153			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
154				<h2>Properties</h2>
155				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
156					<a name="ptr" class="tsd-anchor"></a>
157					<h3>ptr</h3>
158					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
159					<aside class="tsd-sources">
160						<p>Inherited from <a href="deltacomponentref.html">DeltaComponentRef</a>.<a href="deltacomponentref.html#ptr">ptr</a></p>
161						<ul>
162							<li>Defined in livesplit_core.ts:1990</li>
163						</ul>
164					</aside>
165				</section>
166			</section>
167			<section class="tsd-panel-group tsd-member-group ">
168				<h2>Methods</h2>
169				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
170					<a name="state" class="tsd-anchor"></a>
171					<h3>state</h3>
172					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
173						<li class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a>, layoutSettings<span class="tsd-signature-symbol">: </span><a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="deltacomponentstate.html" class="tsd-signature-type">DeltaComponentState</a></li>
174					</ul>
175					<ul class="tsd-descriptions">
176						<li class="tsd-description">
177							<aside class="tsd-sources">
178								<ul>
179									<li>Defined in livesplit_core.ts:2024</li>
180								</ul>
181							</aside>
182							<div class="tsd-comment tsd-typography">
183								<div class="lead">
184									<p>Calculates the component&#39;s state based on the timer and the layout
185									settings provided.</p>
186								</div>
187							</div>
188							<h4 class="tsd-parameters-title">Parameters</h4>
189							<ul class="tsd-parameters">
190								<li>
191									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
192								</li>
193								<li>
194									<h5>layoutSettings: <a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a></h5>
195								</li>
196							</ul>
197							<h4 class="tsd-returns-title">Returns <a href="deltacomponentstate.html" class="tsd-signature-type">DeltaComponentState</a></h4>
198						</li>
199					</ul>
200				</section>
201				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
202					<a name="stateasjson" class="tsd-anchor"></a>
203					<h3>state<wbr>AsJson</h3>
204					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
205						<li class="tsd-signature tsd-kind-icon">state<wbr>AsJson<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a>, layoutSettings<span class="tsd-signature-symbol">: </span><a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
206					</ul>
207					<ul class="tsd-descriptions">
208						<li class="tsd-description">
209							<aside class="tsd-sources">
210								<ul>
211									<li>Defined in livesplit_core.ts:2007</li>
212								</ul>
213							</aside>
214							<div class="tsd-comment tsd-typography">
215								<div class="lead">
216									<p>Encodes the component&#39;s state information as JSON.</p>
217								</div>
218							</div>
219							<h4 class="tsd-parameters-title">Parameters</h4>
220							<ul class="tsd-parameters">
221								<li>
222									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
223								</li>
224								<li>
225									<h5>layoutSettings: <a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a></h5>
226								</li>
227							</ul>
228							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
229						</li>
230					</ul>
231				</section>
232			</section>
233		</div>
234		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
235			<nav class="tsd-navigation primary">
236				<ul>
237					<li class="globals  ">
238						<a href="../globals.html"><em>Globals</em></a>
239					</li>
240				</ul>
241			</nav>
242			<nav class="tsd-navigation secondary menu-sticky">
243				<ul class="before-current">
244				</ul>
245				<ul class="current">
246					<li class="current tsd-kind-class">
247						<a href="deltacomponentrefmut.html" class="tsd-kind-icon">Delta<wbr>Component<wbr>Ref<wbr>Mut</a>
248						<ul>
249							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
250								<a href="deltacomponentrefmut.html#constructor" class="tsd-kind-icon">constructor</a>
251							</li>
252							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
253								<a href="deltacomponentrefmut.html#ptr" class="tsd-kind-icon">ptr</a>
254							</li>
255							<li class=" tsd-kind-method tsd-parent-kind-class">
256								<a href="deltacomponentrefmut.html#state" class="tsd-kind-icon">state</a>
257							</li>
258							<li class=" tsd-kind-method tsd-parent-kind-class">
259								<a href="deltacomponentrefmut.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a>
260							</li>
261						</ul>
262					</li>
263				</ul>
264				<ul class="after-current">
265				</ul>
266			</nav>
267		</div>
268	</div>
269</div>
270<footer class="with-border-bottom">
271	<div class="container">
272		<h2>Legend</h2>
273		<div class="tsd-legend-group">
274			<ul class="tsd-legend">
275				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
276				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
277				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
278				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
279				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
280				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
281				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
282			</ul>
283			<ul class="tsd-legend">
284				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
285				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
286				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
287				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
288			</ul>
289			<ul class="tsd-legend">
290				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
291				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
292				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
293				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
294				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
295				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
296			</ul>
297			<ul class="tsd-legend">
298				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
299				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
300				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
301				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
302				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
303				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
304				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
305			</ul>
306			<ul class="tsd-legend">
307				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
308				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
309				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
310				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
311			</ul>
312			<ul class="tsd-legend">
313				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
314				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
315				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
316			</ul>
317			<ul class="tsd-legend">
318				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
319				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
320				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
321			</ul>
322			<ul class="tsd-legend">
323				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
324				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
325			</ul>
326		</div>
327	</div>
328</footer>
329<div class="container tsd-generator">
330	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
331</div>
332<div class="overlay"></div>
333<script src="../assets/js/main.js"></script>
334<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
335</body>
336</html>