fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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