fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
34.6 KiB669 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>SplitsComponentState | 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="splitscomponentstate.html">SplitsComponentState</a>
60				</li>
61			</ul>
62			<h1>Class SplitsComponentState</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 state object that describes a single segment&#39;s information to visualize.</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						<a href="splitscomponentstaterefmut.html" class="tsd-signature-type">SplitsComponentStateRefMut</a>
81						<ul class="tsd-hierarchy">
82							<li>
83								<span class="target">SplitsComponentState</span>
84							</li>
85						</ul>
86					</li>
87				</ul>
88			</section>
89			<section class="tsd-panel-group tsd-index-group">
90				<h2>Index</h2>
91				<section class="tsd-panel tsd-index-panel">
92					<div class="tsd-index-content">
93						<section class="tsd-index-section tsd-is-inherited">
94							<h3>Constructors</h3>
95							<ul class="tsd-index-list">
96								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#constructor" class="tsd-kind-icon">constructor</a></li>
97							</ul>
98						</section>
99						<section class="tsd-index-section tsd-is-inherited">
100							<h3>Properties</h3>
101							<ul class="tsd-index-list">
102								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#ptr" class="tsd-kind-icon">ptr</a></li>
103							</ul>
104						</section>
105						<section class="tsd-index-section ">
106							<h3>Methods</h3>
107							<ul class="tsd-index-list">
108								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#delta" class="tsd-kind-icon">delta</a></li>
109								<li class="tsd-kind-method tsd-parent-kind-class"><a href="splitscomponentstate.html#dispose" class="tsd-kind-icon">dispose</a></li>
110								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#finalseparatorshown" class="tsd-kind-icon">final<wbr>Separator<wbr>Shown</a></li>
111								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#iconchangecount" class="tsd-kind-icon">icon<wbr>Change<wbr>Count</a></li>
112								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#iconchangeicon" class="tsd-kind-icon">icon<wbr>Change<wbr>Icon</a></li>
113								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#iconchangesegmentindex" class="tsd-kind-icon">icon<wbr>Change<wbr>Segment<wbr>Index</a></li>
114								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#iscurrentsplit" class="tsd-kind-icon">is<wbr>Current<wbr>Split</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#len" class="tsd-kind-icon">len</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#name" class="tsd-kind-icon">name</a></li>
117								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#semanticcolor" class="tsd-kind-icon">semantic<wbr>Color</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponentstate.html#time" class="tsd-kind-icon">time</a></li>
119								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="splitscomponentstate.html#with" class="tsd-kind-icon">with</a></li>
120							</ul>
121						</section>
122					</div>
123				</section>
124			</section>
125			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
126				<h2>Constructors</h2>
127				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
128					<a name="constructor" class="tsd-anchor"></a>
129					<h3>constructor</h3>
130					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
131						<li class="tsd-signature tsd-kind-icon">new <wbr>Splits<wbr>Component<wbr>State<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="splitscomponentstate.html" class="tsd-signature-type">SplitsComponentState</a></li>
132					</ul>
133					<ul class="tsd-descriptions">
134						<li class="tsd-description">
135							<aside class="tsd-sources">
136								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#constructor">constructor</a></p>
137								<ul>
138									<li>Defined in livesplit_core.ts:6038</li>
139								</ul>
140							</aside>
141							<div class="tsd-comment tsd-typography">
142								<div class="lead">
143									<p>This constructor is an implementation detail. Do not use this.</p>
144								</div>
145							</div>
146							<h4 class="tsd-parameters-title">Parameters</h4>
147							<ul class="tsd-parameters">
148								<li>
149									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
150								</li>
151							</ul>
152							<h4 class="tsd-returns-title">Returns <a href="splitscomponentstate.html" class="tsd-signature-type">SplitsComponentState</a></h4>
153						</li>
154					</ul>
155				</section>
156			</section>
157			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
158				<h2>Properties</h2>
159				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
160					<a name="ptr" class="tsd-anchor"></a>
161					<h3>ptr</h3>
162					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
163					<aside class="tsd-sources">
164						<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#ptr">ptr</a></p>
165						<ul>
166							<li>Defined in livesplit_core.ts:5927</li>
167						</ul>
168					</aside>
169				</section>
170			</section>
171			<section class="tsd-panel-group tsd-member-group ">
172				<h2>Methods</h2>
173				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
174					<a name="delta" class="tsd-anchor"></a>
175					<h3>delta</h3>
176					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
177						<li class="tsd-signature tsd-kind-icon">delta<span class="tsd-signature-symbol">(</span>index<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><span class="tsd-signature-type">string</span></li>
178					</ul>
179					<ul class="tsd-descriptions">
180						<li class="tsd-description">
181							<aside class="tsd-sources">
182								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#delta">delta</a></p>
183								<ul>
184									<li>Defined in livesplit_core.ts:5999</li>
185								</ul>
186							</aside>
187							<div class="tsd-comment tsd-typography">
188								<div class="lead">
189									<p>The delta to show for the segment with the specified index. You may not
190									provide an out of bounds index.</p>
191								</div>
192							</div>
193							<h4 class="tsd-parameters-title">Parameters</h4>
194							<ul class="tsd-parameters">
195								<li>
196									<h5>index: <span class="tsd-signature-type">number</span></h5>
197								</li>
198							</ul>
199							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
200						</li>
201					</ul>
202				</section>
203				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
204					<a name="dispose" class="tsd-anchor"></a>
205					<h3>dispose</h3>
206					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
207						<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
208					</ul>
209					<ul class="tsd-descriptions">
210						<li class="tsd-description">
211							<aside class="tsd-sources">
212								<ul>
213									<li>Defined in livesplit_core.ts:6075</li>
214								</ul>
215							</aside>
216							<div class="tsd-comment tsd-typography">
217								<div class="lead">
218									<p>Disposes the object, allowing it to clean up all of its memory. You need
219										to call this for every object that you don&#39;t use anymore and hasn&#39;t
220									already been disposed.</p>
221								</div>
222							</div>
223							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
224						</li>
225					</ul>
226				</section>
227				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
228					<a name="finalseparatorshown" class="tsd-anchor"></a>
229					<h3>final<wbr>Separator<wbr>Shown</h3>
230					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
231						<li class="tsd-signature tsd-kind-icon">final<wbr>Separator<wbr>Shown<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
232					</ul>
233					<ul class="tsd-descriptions">
234						<li class="tsd-description">
235							<aside class="tsd-sources">
236								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#finalseparatorshown">finalSeparatorShown</a></p>
237								<ul>
238									<li>Defined in livesplit_core.ts:5932</li>
239								</ul>
240							</aside>
241							<div class="tsd-comment tsd-typography">
242								<div class="lead">
243									<p>Describes whether a more pronounced separator should be shown in front of
244									the last segment provided.</p>
245								</div>
246							</div>
247							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
248						</li>
249					</ul>
250				</section>
251				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
252					<a name="iconchangecount" class="tsd-anchor"></a>
253					<h3>icon<wbr>Change<wbr>Count</h3>
254					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
255						<li class="tsd-signature tsd-kind-icon">icon<wbr>Change<wbr>Count<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
256					</ul>
257					<ul class="tsd-descriptions">
258						<li class="tsd-description">
259							<aside class="tsd-sources">
260								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#iconchangecount">iconChangeCount</a></p>
261								<ul>
262									<li>Defined in livesplit_core.ts:5952</li>
263								</ul>
264							</aside>
265							<div class="tsd-comment tsd-typography">
266								<div class="lead">
267									<p>Returns the amount of icon changes that happened in this state object.</p>
268								</div>
269							</div>
270							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
271						</li>
272					</ul>
273				</section>
274				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
275					<a name="iconchangeicon" class="tsd-anchor"></a>
276					<h3>icon<wbr>Change<wbr>Icon</h3>
277					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
278						<li class="tsd-signature tsd-kind-icon">icon<wbr>Change<wbr>Icon<span class="tsd-signature-symbol">(</span>iconChangeIndex<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><span class="tsd-signature-type">string</span></li>
279					</ul>
280					<ul class="tsd-descriptions">
281						<li class="tsd-description">
282							<aside class="tsd-sources">
283								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#iconchangeicon">iconChangeIcon</a></p>
284								<ul>
285									<li>Defined in livesplit_core.ts:5977</li>
286								</ul>
287							</aside>
288							<div class="tsd-comment tsd-typography">
289								<div class="lead">
290									<p>The segment&#39;s icon encoded as a Data URL of the icon change with the
291										specified index. The String itself may be empty. This indicates that there
292									is no icon. You may not provide an out of bounds index.</p>
293								</div>
294							</div>
295							<h4 class="tsd-parameters-title">Parameters</h4>
296							<ul class="tsd-parameters">
297								<li>
298									<h5>iconChangeIndex: <span class="tsd-signature-type">number</span></h5>
299								</li>
300							</ul>
301							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
302						</li>
303					</ul>
304				</section>
305				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
306					<a name="iconchangesegmentindex" class="tsd-anchor"></a>
307					<h3>icon<wbr>Change<wbr>Segment<wbr>Index</h3>
308					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
309						<li class="tsd-signature tsd-kind-icon">icon<wbr>Change<wbr>Segment<wbr>Index<span class="tsd-signature-symbol">(</span>iconChangeIndex<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><span class="tsd-signature-type">number</span></li>
310					</ul>
311					<ul class="tsd-descriptions">
312						<li class="tsd-description">
313							<aside class="tsd-sources">
314								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#iconchangesegmentindex">iconChangeSegmentIndex</a></p>
315								<ul>
316									<li>Defined in livesplit_core.ts:5965</li>
317								</ul>
318							</aside>
319							<div class="tsd-comment tsd-typography">
320								<div class="lead">
321									<p>Accesses the index of the segment of the icon change with the specified
322										index. This is based on the index in the run, not on the index of the
323										SplitState in the State object. The corresponding index is the index field
324									of the SplitState object. You may not provide an out of bounds index.</p>
325								</div>
326							</div>
327							<h4 class="tsd-parameters-title">Parameters</h4>
328							<ul class="tsd-parameters">
329								<li>
330									<h5>iconChangeIndex: <span class="tsd-signature-type">number</span></h5>
331								</li>
332							</ul>
333							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
334						</li>
335					</ul>
336				</section>
337				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
338					<a name="iscurrentsplit" class="tsd-anchor"></a>
339					<h3>is<wbr>Current<wbr>Split</h3>
340					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
341						<li class="tsd-signature tsd-kind-icon">is<wbr>Current<wbr>Split<span class="tsd-signature-symbol">(</span>index<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><span class="tsd-signature-type">boolean</span></li>
342					</ul>
343					<ul class="tsd-descriptions">
344						<li class="tsd-description">
345							<aside class="tsd-sources">
346								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#iscurrentsplit">isCurrentSplit</a></p>
347								<ul>
348									<li>Defined in livesplit_core.ts:6032</li>
349								</ul>
350							</aside>
351							<div class="tsd-comment tsd-typography">
352								<div class="lead">
353									<p>Describes if the segment with the specified index is the segment the active
354									attempt is currently on.</p>
355								</div>
356							</div>
357							<h4 class="tsd-parameters-title">Parameters</h4>
358							<ul class="tsd-parameters">
359								<li>
360									<h5>index: <span class="tsd-signature-type">number</span></h5>
361								</li>
362							</ul>
363							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
364						</li>
365					</ul>
366				</section>
367				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
368					<a name="len" class="tsd-anchor"></a>
369					<h3>len</h3>
370					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
371						<li class="tsd-signature tsd-kind-icon">len<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
372					</ul>
373					<ul class="tsd-descriptions">
374						<li class="tsd-description">
375							<aside class="tsd-sources">
376								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#len">len</a></p>
377								<ul>
378									<li>Defined in livesplit_core.ts:5942</li>
379								</ul>
380							</aside>
381							<div class="tsd-comment tsd-typography">
382								<div class="lead">
383									<p>Returns the amount of segments to visualize.</p>
384								</div>
385							</div>
386							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
387						</li>
388					</ul>
389				</section>
390				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
391					<a name="name" class="tsd-anchor"></a>
392					<h3>name</h3>
393					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
394						<li class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">(</span>index<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><span class="tsd-signature-type">string</span></li>
395					</ul>
396					<ul class="tsd-descriptions">
397						<li class="tsd-description">
398							<aside class="tsd-sources">
399								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#name">name</a></p>
400								<ul>
401									<li>Defined in livesplit_core.ts:5988</li>
402								</ul>
403							</aside>
404							<div class="tsd-comment tsd-typography">
405								<div class="lead">
406									<p>The name of the segment with the specified index. You may not provide an out
407									of bounds index.</p>
408								</div>
409							</div>
410							<h4 class="tsd-parameters-title">Parameters</h4>
411							<ul class="tsd-parameters">
412								<li>
413									<h5>index: <span class="tsd-signature-type">number</span></h5>
414								</li>
415							</ul>
416							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
417						</li>
418					</ul>
419				</section>
420				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
421					<a name="semanticcolor" class="tsd-anchor"></a>
422					<h3>semantic<wbr>Color</h3>
423					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
424						<li class="tsd-signature tsd-kind-icon">semantic<wbr>Color<span class="tsd-signature-symbol">(</span>index<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><span class="tsd-signature-type">string</span></li>
425					</ul>
426					<ul class="tsd-descriptions">
427						<li class="tsd-description">
428							<aside class="tsd-sources">
429								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#semanticcolor">semanticColor</a></p>
430								<ul>
431									<li>Defined in livesplit_core.ts:6021</li>
432								</ul>
433							</aside>
434							<div class="tsd-comment tsd-typography">
435								<div class="lead">
436									<p>The semantic coloring information the delta time carries of the segment with
437									the specified index. You may not provide an out of bounds index.</p>
438								</div>
439							</div>
440							<h4 class="tsd-parameters-title">Parameters</h4>
441							<ul class="tsd-parameters">
442								<li>
443									<h5>index: <span class="tsd-signature-type">number</span></h5>
444								</li>
445							</ul>
446							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
447						</li>
448					</ul>
449				</section>
450				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
451					<a name="time" class="tsd-anchor"></a>
452					<h3>time</h3>
453					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
454						<li class="tsd-signature tsd-kind-icon">time<span class="tsd-signature-symbol">(</span>index<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><span class="tsd-signature-type">string</span></li>
455					</ul>
456					<ul class="tsd-descriptions">
457						<li class="tsd-description">
458							<aside class="tsd-sources">
459								<p>Inherited from <a href="splitscomponentstateref.html">SplitsComponentStateRef</a>.<a href="splitscomponentstateref.html#time">time</a></p>
460								<ul>
461									<li>Defined in livesplit_core.ts:6010</li>
462								</ul>
463							</aside>
464							<div class="tsd-comment tsd-typography">
465								<div class="lead">
466									<p>The split time to show for the segment with the specified index. You may not
467									provide an out of bounds index.</p>
468								</div>
469							</div>
470							<h4 class="tsd-parameters-title">Parameters</h4>
471							<ul class="tsd-parameters">
472								<li>
473									<h5>index: <span class="tsd-signature-type">number</span></h5>
474								</li>
475							</ul>
476							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
477						</li>
478					</ul>
479				</section>
480				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
481					<a name="with" class="tsd-anchor"></a>
482					<h3>with</h3>
483					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
484						<li class="tsd-signature tsd-kind-icon">with&lt;T&gt;<span class="tsd-signature-symbol">(</span>closure<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
485					</ul>
486					<ul class="tsd-descriptions">
487						<li class="tsd-description">
488							<aside class="tsd-sources">
489								<ul>
490									<li>Defined in livesplit_core.ts:6063</li>
491								</ul>
492							</aside>
493							<div class="tsd-comment tsd-typography">
494								<div class="lead">
495									<p>Allows for scoped usage of the object. The object is guaranteed to get
496										disposed once this function returns. You are free to dispose the object
497										early yourself anywhere within the scope. The scope&#39;s return value gets
498									carried to the outside of this function.</p>
499								</div>
500							</div>
501							<h4 class="tsd-type-parameters-title">Type parameters</h4>
502							<ul class="tsd-type-parameters">
503								<li>
504									<h4>T</h4>
505								</li>
506							</ul>
507							<h4 class="tsd-parameters-title">Parameters</h4>
508							<ul class="tsd-parameters">
509								<li>
510									<h5>closure: <span class="tsd-signature-type">function</span></h5>
511									<ul class="tsd-parameters">
512										<li class="tsd-parameter-siganture">
513											<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
514												<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="splitscomponentstate.html" class="tsd-signature-type">SplitsComponentState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
515											</ul>
516											<ul class="tsd-descriptions">
517												<li class="tsd-description">
518													<h4 class="tsd-parameters-title">Parameters</h4>
519													<ul class="tsd-parameters">
520														<li>
521															<h5>obj: <a href="splitscomponentstate.html" class="tsd-signature-type">SplitsComponentState</a></h5>
522														</li>
523													</ul>
524													<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
525												</li>
526											</ul>
527										</li>
528									</ul>
529								</li>
530							</ul>
531							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
532						</li>
533					</ul>
534				</section>
535			</section>
536		</div>
537		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
538			<nav class="tsd-navigation primary">
539				<ul>
540					<li class="globals  ">
541						<a href="../globals.html"><em>Globals</em></a>
542					</li>
543				</ul>
544			</nav>
545			<nav class="tsd-navigation secondary menu-sticky">
546				<ul class="before-current">
547				</ul>
548				<ul class="current">
549					<li class="current tsd-kind-class">
550						<a href="splitscomponentstate.html" class="tsd-kind-icon">Splits<wbr>Component<wbr>State</a>
551						<ul>
552							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
553								<a href="splitscomponentstate.html#constructor" class="tsd-kind-icon">constructor</a>
554							</li>
555							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
556								<a href="splitscomponentstate.html#ptr" class="tsd-kind-icon">ptr</a>
557							</li>
558							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
559								<a href="splitscomponentstate.html#delta" class="tsd-kind-icon">delta</a>
560							</li>
561							<li class=" tsd-kind-method tsd-parent-kind-class">
562								<a href="splitscomponentstate.html#dispose" class="tsd-kind-icon">dispose</a>
563							</li>
564							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
565								<a href="splitscomponentstate.html#finalseparatorshown" class="tsd-kind-icon">final<wbr>Separator<wbr>Shown</a>
566							</li>
567							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
568								<a href="splitscomponentstate.html#iconchangecount" class="tsd-kind-icon">icon<wbr>Change<wbr>Count</a>
569							</li>
570							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
571								<a href="splitscomponentstate.html#iconchangeicon" class="tsd-kind-icon">icon<wbr>Change<wbr>Icon</a>
572							</li>
573							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
574								<a href="splitscomponentstate.html#iconchangesegmentindex" class="tsd-kind-icon">icon<wbr>Change<wbr>Segment<wbr>Index</a>
575							</li>
576							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
577								<a href="splitscomponentstate.html#iscurrentsplit" class="tsd-kind-icon">is<wbr>Current<wbr>Split</a>
578							</li>
579							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
580								<a href="splitscomponentstate.html#len" class="tsd-kind-icon">len</a>
581							</li>
582							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
583								<a href="splitscomponentstate.html#name" class="tsd-kind-icon">name</a>
584							</li>
585							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
586								<a href="splitscomponentstate.html#semanticcolor" class="tsd-kind-icon">semantic<wbr>Color</a>
587							</li>
588							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
589								<a href="splitscomponentstate.html#time" class="tsd-kind-icon">time</a>
590							</li>
591							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
592								<a href="splitscomponentstate.html#with" class="tsd-kind-icon">with</a>
593							</li>
594						</ul>
595					</li>
596				</ul>
597				<ul class="after-current">
598				</ul>
599			</nav>
600		</div>
601	</div>
602</div>
603<footer class="with-border-bottom">
604	<div class="container">
605		<h2>Legend</h2>
606		<div class="tsd-legend-group">
607			<ul class="tsd-legend">
608				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
609				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
610				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
611				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
612				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
613				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
614				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
615			</ul>
616			<ul class="tsd-legend">
617				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
618				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
619				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
620				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
621			</ul>
622			<ul class="tsd-legend">
623				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
624				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
625				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
626				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
627				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
628				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
629			</ul>
630			<ul class="tsd-legend">
631				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
632				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
633				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
634				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
635				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
636				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
637				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
638			</ul>
639			<ul class="tsd-legend">
640				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
641				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
642				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
643				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
644			</ul>
645			<ul class="tsd-legend">
646				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
647				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
648				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
649			</ul>
650			<ul class="tsd-legend">
651				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
652				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
653				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
654			</ul>
655			<ul class="tsd-legend">
656				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
657				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
658			</ul>
659		</div>
660	</div>
661</footer>
662<div class="container tsd-generator">
663	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
664</div>
665<div class="overlay"></div>
666<script src="../assets/js/main.js"></script>
667<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
668</body>
669</html>