fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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