fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
64.7 KiB1233 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>Run | 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="run.html">Run</a>
60				</li>
61			</ul>
62			<h1>Class Run</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>A Run stores the split times for a specific game and category of a runner.</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="runrefmut.html" class="tsd-signature-type">RunRefMut</a>
81						<ul class="tsd-hierarchy">
82							<li>
83								<span class="target">Run</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="run.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="run.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="run.html#attemptcount" class="tsd-kind-icon">attempt<wbr>Count</a></li>
109								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#attempthistoryindex" class="tsd-kind-icon">attempt<wbr>History<wbr>Index</a></li>
110								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#attempthistorylen" class="tsd-kind-icon">attempt<wbr>History<wbr>Len</a></li>
111								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#autosplittersettings" class="tsd-kind-icon">auto<wbr>Splitter<wbr>Settings</a></li>
112								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#categoryname" class="tsd-kind-icon">category<wbr>Name</a></li>
113								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#clone" class="tsd-kind-icon">clone</a></li>
114								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#customcomparison" class="tsd-kind-icon">custom<wbr>Comparison</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#customcomparisonslen" class="tsd-kind-icon">custom<wbr>Comparisons<wbr>Len</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class"><a href="run.html#dispose" class="tsd-kind-icon">dispose</a></li>
117								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#extendedcategoryname" class="tsd-kind-icon">extended<wbr>Category<wbr>Name</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#extendedfilename" class="tsd-kind-icon">extended<wbr>File<wbr>Name</a></li>
119								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#extendedname" class="tsd-kind-icon">extended<wbr>Name</a></li>
120								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#gameicon" class="tsd-kind-icon">game<wbr>Icon</a></li>
121								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#gamename" class="tsd-kind-icon">game<wbr>Name</a></li>
122								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#hasbeenmodified" class="tsd-kind-icon">has<wbr>Been<wbr>Modified</a></li>
123								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#len" class="tsd-kind-icon">len</a></li>
124								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#markasmodified" class="tsd-kind-icon">mark<wbr>AsModified</a></li>
125								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#metadata" class="tsd-kind-icon">metadata</a></li>
126								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#offset" class="tsd-kind-icon">offset</a></li>
127								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#pushsegment" class="tsd-kind-icon">push<wbr>Segment</a></li>
128								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#saveaslss" class="tsd-kind-icon">save<wbr>AsLss</a></li>
129								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#segment" class="tsd-kind-icon">segment</a></li>
130								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#setcategoryname" class="tsd-kind-icon">set<wbr>Category<wbr>Name</a></li>
131								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="run.html#setgamename" class="tsd-kind-icon">set<wbr>Game<wbr>Name</a></li>
132								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="run.html#with" class="tsd-kind-icon">with</a></li>
133								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="run.html#new" class="tsd-kind-icon">new</a></li>
134								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="run.html#parse" class="tsd-kind-icon">parse</a></li>
135								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="run.html#parsearray" class="tsd-kind-icon">parse<wbr>Array</a></li>
136								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="run.html#parsefilehandle" class="tsd-kind-icon">parse<wbr>File<wbr>Handle</a></li>
137								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="run.html#parsestring" class="tsd-kind-icon">parse<wbr>String</a></li>
138							</ul>
139						</section>
140					</div>
141				</section>
142			</section>
143			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
144				<h2>Constructors</h2>
145				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
146					<a name="constructor" class="tsd-anchor"></a>
147					<h3>constructor</h3>
148					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
149						<li class="tsd-signature tsd-kind-icon">new <wbr>Run<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="run.html" class="tsd-signature-type">Run</a></li>
150					</ul>
151					<ul class="tsd-descriptions">
152						<li class="tsd-description">
153							<aside class="tsd-sources">
154								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#constructor">constructor</a></p>
155								<ul>
156									<li>Defined in livesplit_core.ts:4118</li>
157								</ul>
158							</aside>
159							<div class="tsd-comment tsd-typography">
160								<div class="lead">
161									<p>This constructor is an implementation detail. Do not use this.</p>
162								</div>
163							</div>
164							<h4 class="tsd-parameters-title">Parameters</h4>
165							<ul class="tsd-parameters">
166								<li>
167									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
168								</li>
169							</ul>
170							<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
171						</li>
172					</ul>
173				</section>
174			</section>
175			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
176				<h2>Properties</h2>
177				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
178					<a name="ptr" class="tsd-anchor"></a>
179					<h3>ptr</h3>
180					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
181					<aside class="tsd-sources">
182						<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#ptr">ptr</a></p>
183						<ul>
184							<li>Defined in livesplit_core.ts:3901</li>
185						</ul>
186					</aside>
187				</section>
188			</section>
189			<section class="tsd-panel-group tsd-member-group ">
190				<h2>Methods</h2>
191				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
192					<a name="attemptcount" class="tsd-anchor"></a>
193					<h3>attempt<wbr>Count</h3>
194					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
195						<li class="tsd-signature tsd-kind-icon">attempt<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>
196					</ul>
197					<ul class="tsd-descriptions">
198						<li class="tsd-description">
199							<aside class="tsd-sources">
200								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#attemptcount">attemptCount</a></p>
201								<ul>
202									<li>Defined in livesplit_core.ts:3992</li>
203								</ul>
204							</aside>
205							<div class="tsd-comment tsd-typography">
206								<div class="lead">
207									<p>Returns the amount of runs that have been attempted with these splits.</p>
208								</div>
209							</div>
210							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
211						</li>
212					</ul>
213				</section>
214				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
215					<a name="attempthistoryindex" class="tsd-anchor"></a>
216					<h3>attempt<wbr>History<wbr>Index</h3>
217					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
218						<li class="tsd-signature tsd-kind-icon">attempt<wbr>History<wbr>Index<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><a href="attemptref.html" class="tsd-signature-type">AttemptRef</a></li>
219					</ul>
220					<ul class="tsd-descriptions">
221						<li class="tsd-description">
222							<aside class="tsd-sources">
223								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#attempthistoryindex">attemptHistoryIndex</a></p>
224								<ul>
225									<li>Defined in livesplit_core.ts:4068</li>
226								</ul>
227							</aside>
228							<div class="tsd-comment tsd-typography">
229								<div class="lead">
230									<p>Accesses the an attempt history element by its index. This does not store
231										the actual segment times, just the overall attempt information. Information
232										about the individual segments is stored within each segment. You may not
233									provide an out of bounds index.</p>
234								</div>
235							</div>
236							<h4 class="tsd-parameters-title">Parameters</h4>
237							<ul class="tsd-parameters">
238								<li>
239									<h5>index: <span class="tsd-signature-type">number</span></h5>
240								</li>
241							</ul>
242							<h4 class="tsd-returns-title">Returns <a href="attemptref.html" class="tsd-signature-type">AttemptRef</a></h4>
243						</li>
244					</ul>
245				</section>
246				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
247					<a name="attempthistorylen" class="tsd-anchor"></a>
248					<h3>attempt<wbr>History<wbr>Len</h3>
249					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
250						<li class="tsd-signature tsd-kind-icon">attempt<wbr>History<wbr>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>
251					</ul>
252					<ul class="tsd-descriptions">
253						<li class="tsd-description">
254							<aside class="tsd-sources">
255								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#attempthistorylen">attemptHistoryLen</a></p>
256								<ul>
257									<li>Defined in livesplit_core.ts:4055</li>
258								</ul>
259							</aside>
260							<div class="tsd-comment tsd-typography">
261								<div class="lead">
262									<p>Returns the amount attempt history elements are stored in this Run.</p>
263								</div>
264							</div>
265							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
266						</li>
267					</ul>
268				</section>
269				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
270					<a name="autosplittersettings" class="tsd-anchor"></a>
271					<h3>auto<wbr>Splitter<wbr>Settings</h3>
272					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
273						<li class="tsd-signature tsd-kind-icon">auto<wbr>Splitter<wbr>Settings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
274					</ul>
275					<ul class="tsd-descriptions">
276						<li class="tsd-description">
277							<aside class="tsd-sources">
278								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#autosplittersettings">autoSplitterSettings</a></p>
279								<ul>
280									<li>Defined in livesplit_core.ts:4112</li>
281								</ul>
282							</aside>
283							<div class="tsd-comment tsd-typography">
284								<div class="lead">
285									<p>Accesses the Auto Splitter Settings that are encoded as XML.</p>
286								</div>
287							</div>
288							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
289						</li>
290					</ul>
291				</section>
292				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
293					<a name="categoryname" class="tsd-anchor"></a>
294					<h3>category<wbr>Name</h3>
295					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
296						<li class="tsd-signature tsd-kind-icon">category<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
297					</ul>
298					<ul class="tsd-descriptions">
299						<li class="tsd-description">
300							<aside class="tsd-sources">
301								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#categoryname">categoryName</a></p>
302								<ul>
303									<li>Defined in livesplit_core.ts:3936</li>
304								</ul>
305							</aside>
306							<div class="tsd-comment tsd-typography">
307								<div class="lead">
308									<p>Accesses the name of the category this Run is for.</p>
309								</div>
310							</div>
311							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
312						</li>
313					</ul>
314				</section>
315				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
316					<a name="clone" class="tsd-anchor"></a>
317					<h3>clone</h3>
318					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
319						<li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="run.html" class="tsd-signature-type">Run</a></li>
320					</ul>
321					<ul class="tsd-descriptions">
322						<li class="tsd-description">
323							<aside class="tsd-sources">
324								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#clone">clone</a></p>
325								<ul>
326									<li>Defined in livesplit_core.ts:3905</li>
327								</ul>
328							</aside>
329							<div class="tsd-comment tsd-typography">
330								<div class="lead">
331									<p>Clones the Run object.</p>
332								</div>
333							</div>
334							<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
335						</li>
336					</ul>
337				</section>
338				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
339					<a name="customcomparison" class="tsd-anchor"></a>
340					<h3>custom<wbr>Comparison</h3>
341					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
342						<li class="tsd-signature tsd-kind-icon">custom<wbr>Comparison<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>
343					</ul>
344					<ul class="tsd-descriptions">
345						<li class="tsd-description">
346							<aside class="tsd-sources">
347								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#customcomparison">customComparison</a></p>
348								<ul>
349									<li>Defined in livesplit_core.ts:4102</li>
350								</ul>
351							</aside>
352							<div class="tsd-comment tsd-typography">
353								<div class="lead">
354									<p>Accesses a custom comparison stored in this Run by its index. This includes
355										<code>Personal Best</code> but excludes all the other Comparison Generators. You may
356									not provide an out of bounds index.</p>
357								</div>
358							</div>
359							<h4 class="tsd-parameters-title">Parameters</h4>
360							<ul class="tsd-parameters">
361								<li>
362									<h5>index: <span class="tsd-signature-type">number</span></h5>
363								</li>
364							</ul>
365							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
366						</li>
367					</ul>
368				</section>
369				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
370					<a name="customcomparisonslen" class="tsd-anchor"></a>
371					<h3>custom<wbr>Comparisons<wbr>Len</h3>
372					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
373						<li class="tsd-signature tsd-kind-icon">custom<wbr>Comparisons<wbr>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>
374					</ul>
375					<ul class="tsd-descriptions">
376						<li class="tsd-description">
377							<aside class="tsd-sources">
378								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#customcomparisonslen">customComparisonsLen</a></p>
379								<ul>
380									<li>Defined in livesplit_core.ts:4090</li>
381								</ul>
382							</aside>
383							<div class="tsd-comment tsd-typography">
384								<div class="lead">
385									<p>Returns the amount of custom comparisons stored in this Run.</p>
386								</div>
387							</div>
388							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
389						</li>
390					</ul>
391				</section>
392				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
393					<a name="dispose" class="tsd-anchor"></a>
394					<h3>dispose</h3>
395					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
396						<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>
397					</ul>
398					<ul class="tsd-descriptions">
399						<li class="tsd-description">
400							<aside class="tsd-sources">
401								<ul>
402									<li>Defined in livesplit_core.ts:4196</li>
403								</ul>
404							</aside>
405							<div class="tsd-comment tsd-typography">
406								<div class="lead">
407									<p>Disposes the object, allowing it to clean up all of its memory. You need
408										to call this for every object that you don&#39;t use anymore and hasn&#39;t
409									already been disposed.</p>
410								</div>
411							</div>
412							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
413						</li>
414					</ul>
415				</section>
416				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
417					<a name="extendedcategoryname" class="tsd-anchor"></a>
418					<h3>extended<wbr>Category<wbr>Name</h3>
419					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
420						<li class="tsd-signature tsd-kind-icon">extended<wbr>Category<wbr>Name<span class="tsd-signature-symbol">(</span>showRegion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, showPlatform<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, showVariables<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
421					</ul>
422					<ul class="tsd-descriptions">
423						<li class="tsd-description">
424							<aside class="tsd-sources">
425								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#extendedcategoryname">extendedCategoryName</a></p>
426								<ul>
427									<li>Defined in livesplit_core.ts:3982</li>
428								</ul>
429							</aside>
430							<div class="tsd-comment tsd-typography">
431								<div class="lead">
432									<p>Returns an extended category name that possibly includes the region,
433										platform and variables, depending on the arguments provided. An extended
434									category name may look like this:</p>
435								</div>
436								<p>Any% (No Tuner, JPN, Wii Emulator)</p>
437							</div>
438							<h4 class="tsd-parameters-title">Parameters</h4>
439							<ul class="tsd-parameters">
440								<li>
441									<h5>showRegion: <span class="tsd-signature-type">boolean</span></h5>
442								</li>
443								<li>
444									<h5>showPlatform: <span class="tsd-signature-type">boolean</span></h5>
445								</li>
446								<li>
447									<h5>showVariables: <span class="tsd-signature-type">boolean</span></h5>
448								</li>
449							</ul>
450							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
451						</li>
452					</ul>
453				</section>
454				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
455					<a name="extendedfilename" class="tsd-anchor"></a>
456					<h3>extended<wbr>File<wbr>Name</h3>
457					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
458						<li class="tsd-signature tsd-kind-icon">extended<wbr>File<wbr>Name<span class="tsd-signature-symbol">(</span>useExtendedCategoryName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
459					</ul>
460					<ul class="tsd-descriptions">
461						<li class="tsd-description">
462							<aside class="tsd-sources">
463								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#extendedfilename">extendedFileName</a></p>
464								<ul>
465									<li>Defined in livesplit_core.ts:3953</li>
466								</ul>
467							</aside>
468							<div class="tsd-comment tsd-typography">
469								<div class="lead">
470									<p>Returns a file name (without the extension) suitable for this Run that
471									is built the following way:</p>
472								</div>
473								<p>Game Name - Category Name</p>
474								<p>If either is empty, the dash is omitted. Special characters that cause
475									problems in file names are also omitted. If an extended category name is
476								used, the variables of the category are appended in a parenthesis.</p>
477							</div>
478							<h4 class="tsd-parameters-title">Parameters</h4>
479							<ul class="tsd-parameters">
480								<li>
481									<h5>useExtendedCategoryName: <span class="tsd-signature-type">boolean</span></h5>
482								</li>
483							</ul>
484							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
485						</li>
486					</ul>
487				</section>
488				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
489					<a name="extendedname" class="tsd-anchor"></a>
490					<h3>extended<wbr>Name</h3>
491					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
492						<li class="tsd-signature tsd-kind-icon">extended<wbr>Name<span class="tsd-signature-symbol">(</span>useExtendedCategoryName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
493					</ul>
494					<ul class="tsd-descriptions">
495						<li class="tsd-description">
496							<aside class="tsd-sources">
497								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#extendedname">extendedName</a></p>
498								<ul>
499									<li>Defined in livesplit_core.ts:3968</li>
500								</ul>
501							</aside>
502							<div class="tsd-comment tsd-typography">
503								<div class="lead">
504									<p>Returns a name suitable for this Run that is built the following way:</p>
505								</div>
506								<p>Game Name - Category Name</p>
507								<p>If either is empty, the dash is omitted. If an extended category name is
508								used, the variables of the category are appended in a parenthesis.</p>
509							</div>
510							<h4 class="tsd-parameters-title">Parameters</h4>
511							<ul class="tsd-parameters">
512								<li>
513									<h5>useExtendedCategoryName: <span class="tsd-signature-type">boolean</span></h5>
514								</li>
515							</ul>
516							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
517						</li>
518					</ul>
519				</section>
520				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
521					<a name="gameicon" class="tsd-anchor"></a>
522					<h3>game<wbr>Icon</h3>
523					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
524						<li class="tsd-signature tsd-kind-icon">game<wbr>Icon<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
525					</ul>
526					<ul class="tsd-descriptions">
527						<li class="tsd-description">
528							<aside class="tsd-sources">
529								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#gameicon">gameIcon</a></p>
530								<ul>
531									<li>Defined in livesplit_core.ts:3926</li>
532								</ul>
533							</aside>
534							<div class="tsd-comment tsd-typography">
535								<div class="lead">
536									<p>Accesses the Data URL storing the game icon&#39;s data. If there is no game
537									icon, this returns an empty string instead of a URL.</p>
538								</div>
539							</div>
540							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
541						</li>
542					</ul>
543				</section>
544				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
545					<a name="gamename" class="tsd-anchor"></a>
546					<h3>game<wbr>Name</h3>
547					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
548						<li class="tsd-signature tsd-kind-icon">game<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
549					</ul>
550					<ul class="tsd-descriptions">
551						<li class="tsd-description">
552							<aside class="tsd-sources">
553								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#gamename">gameName</a></p>
554								<ul>
555									<li>Defined in livesplit_core.ts:3915</li>
556								</ul>
557							</aside>
558							<div class="tsd-comment tsd-typography">
559								<div class="lead">
560									<p>Accesses the name of the game this Run is for.</p>
561								</div>
562							</div>
563							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
564						</li>
565					</ul>
566				</section>
567				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
568					<a name="hasbeenmodified" class="tsd-anchor"></a>
569					<h3>has<wbr>Been<wbr>Modified</h3>
570					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
571						<li class="tsd-signature tsd-kind-icon">has<wbr>Been<wbr>Modified<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>
572					</ul>
573					<ul class="tsd-descriptions">
574						<li class="tsd-description">
575							<aside class="tsd-sources">
576								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#hasbeenmodified">hasBeenModified</a></p>
577								<ul>
578									<li>Defined in livesplit_core.ts:4034</li>
579								</ul>
580							</aside>
581							<div class="tsd-comment tsd-typography">
582								<div class="lead">
583									<p>Returns whether the Run has been modified and should be saved so that the
584									changes don&#39;t get lost.</p>
585								</div>
586							</div>
587							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
588						</li>
589					</ul>
590				</section>
591				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
592					<a name="len" class="tsd-anchor"></a>
593					<h3>len</h3>
594					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
595						<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>
596					</ul>
597					<ul class="tsd-descriptions">
598						<li class="tsd-description">
599							<aside class="tsd-sources">
600								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#len">len</a></p>
601								<ul>
602									<li>Defined in livesplit_core.ts:4023</li>
603								</ul>
604							</aside>
605							<div class="tsd-comment tsd-typography">
606								<div class="lead">
607									<p>Returns the amount of segments stored in this Run.</p>
608								</div>
609							</div>
610							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
611						</li>
612					</ul>
613				</section>
614				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
615					<a name="markasmodified" class="tsd-anchor"></a>
616					<h3>mark<wbr>AsModified</h3>
617					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
618						<li class="tsd-signature tsd-kind-icon">mark<wbr>AsModified<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>
619					</ul>
620					<ul class="tsd-descriptions">
621						<li class="tsd-description">
622							<aside class="tsd-sources">
623								<p>Inherited from <a href="runrefmut.html">RunRefMut</a>.<a href="runrefmut.html#markasmodified">markAsModified</a></p>
624								<ul>
625									<li>Defined in livesplit_core.ts:4166</li>
626								</ul>
627							</aside>
628							<div class="tsd-comment tsd-typography">
629								<div class="lead">
630									<p>Marks the Run as modified, so that it is known that there are changes
631									that should be saved.</p>
632								</div>
633							</div>
634							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
635						</li>
636					</ul>
637				</section>
638				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
639					<a name="metadata" class="tsd-anchor"></a>
640					<h3>metadata</h3>
641					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
642						<li class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="runmetadataref.html" class="tsd-signature-type">RunMetadataRef</a></li>
643					</ul>
644					<ul class="tsd-descriptions">
645						<li class="tsd-description">
646							<aside class="tsd-sources">
647								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#metadata">metadata</a></p>
648								<ul>
649									<li>Defined in livesplit_core.ts:4003</li>
650								</ul>
651							</aside>
652							<div class="tsd-comment tsd-typography">
653								<div class="lead">
654									<p>Accesses additional metadata of this Run, like the platform and region
655									of the game.</p>
656								</div>
657							</div>
658							<h4 class="tsd-returns-title">Returns <a href="runmetadataref.html" class="tsd-signature-type">RunMetadataRef</a></h4>
659						</li>
660					</ul>
661				</section>
662				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
663					<a name="offset" class="tsd-anchor"></a>
664					<h3>offset</h3>
665					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
666						<li class="tsd-signature tsd-kind-icon">offset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="timespanref.html" class="tsd-signature-type">TimeSpanRef</a></li>
667					</ul>
668					<ul class="tsd-descriptions">
669						<li class="tsd-description">
670							<aside class="tsd-sources">
671								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#offset">offset</a></p>
672								<ul>
673									<li>Defined in livesplit_core.ts:4013</li>
674								</ul>
675							</aside>
676							<div class="tsd-comment tsd-typography">
677								<div class="lead">
678									<p>Accesses the time an attempt of this Run should start at.</p>
679								</div>
680							</div>
681							<h4 class="tsd-returns-title">Returns <a href="timespanref.html" class="tsd-signature-type">TimeSpanRef</a></h4>
682						</li>
683					</ul>
684				</section>
685				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
686					<a name="pushsegment" class="tsd-anchor"></a>
687					<h3>push<wbr>Segment</h3>
688					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
689						<li class="tsd-signature tsd-kind-icon">push<wbr>Segment<span class="tsd-signature-symbol">(</span>segment<span class="tsd-signature-symbol">: </span><a href="segment.html" class="tsd-signature-type">Segment</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
690					</ul>
691					<ul class="tsd-descriptions">
692						<li class="tsd-description">
693							<aside class="tsd-sources">
694								<p>Inherited from <a href="runrefmut.html">RunRefMut</a>.<a href="runrefmut.html#pushsegment">pushSegment</a></p>
695								<ul>
696									<li>Defined in livesplit_core.ts:4134</li>
697								</ul>
698							</aside>
699							<div class="tsd-comment tsd-typography">
700								<div class="lead">
701									<p>Pushes the segment provided to the end of the list of segments of this Run.</p>
702								</div>
703							</div>
704							<h4 class="tsd-parameters-title">Parameters</h4>
705							<ul class="tsd-parameters">
706								<li>
707									<h5>segment: <a href="segment.html" class="tsd-signature-type">Segment</a></h5>
708								</li>
709							</ul>
710							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
711						</li>
712					</ul>
713				</section>
714				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
715					<a name="saveaslss" class="tsd-anchor"></a>
716					<h3>save<wbr>AsLss</h3>
717					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
718						<li class="tsd-signature tsd-kind-icon">save<wbr>AsLss<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
719					</ul>
720					<ul class="tsd-descriptions">
721						<li class="tsd-description">
722							<aside class="tsd-sources">
723								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#saveaslss">saveAsLss</a></p>
724								<ul>
725									<li>Defined in livesplit_core.ts:4080</li>
726								</ul>
727							</aside>
728							<div class="tsd-comment tsd-typography">
729								<div class="lead">
730									<p>Saves a Run as a LiveSplit splits file (*.lss). If the run is actively in
731										use by a timer, use the appropriate method on the timer instead, in order to
732									properly save the current attempt as well.</p>
733								</div>
734							</div>
735							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
736						</li>
737					</ul>
738				</section>
739				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
740					<a name="segment" class="tsd-anchor"></a>
741					<h3>segment</h3>
742					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
743						<li class="tsd-signature tsd-kind-icon">segment<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><a href="segmentref.html" class="tsd-signature-type">SegmentRef</a></li>
744					</ul>
745					<ul class="tsd-descriptions">
746						<li class="tsd-description">
747							<aside class="tsd-sources">
748								<p>Inherited from <a href="runref.html">RunRef</a>.<a href="runref.html#segment">segment</a></p>
749								<ul>
750									<li>Defined in livesplit_core.ts:4045</li>
751								</ul>
752							</aside>
753							<div class="tsd-comment tsd-typography">
754								<div class="lead">
755									<p>Accesses a certain segment of this Run. You may not provide an out of bounds
756									index.</p>
757								</div>
758							</div>
759							<h4 class="tsd-parameters-title">Parameters</h4>
760							<ul class="tsd-parameters">
761								<li>
762									<h5>index: <span class="tsd-signature-type">number</span></h5>
763								</li>
764							</ul>
765							<h4 class="tsd-returns-title">Returns <a href="segmentref.html" class="tsd-signature-type">SegmentRef</a></h4>
766						</li>
767					</ul>
768				</section>
769				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
770					<a name="setcategoryname" class="tsd-anchor"></a>
771					<h3>set<wbr>Category<wbr>Name</h3>
772					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
773						<li class="tsd-signature tsd-kind-icon">set<wbr>Category<wbr>Name<span class="tsd-signature-symbol">(</span>category<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
774					</ul>
775					<ul class="tsd-descriptions">
776						<li class="tsd-description">
777							<aside class="tsd-sources">
778								<p>Inherited from <a href="runrefmut.html">RunRefMut</a>.<a href="runrefmut.html#setcategoryname">setCategoryName</a></p>
779								<ul>
780									<li>Defined in livesplit_core.ts:4156</li>
781								</ul>
782							</aside>
783							<div class="tsd-comment tsd-typography">
784								<div class="lead">
785									<p>Sets the name of the category this Run is for.</p>
786								</div>
787							</div>
788							<h4 class="tsd-parameters-title">Parameters</h4>
789							<ul class="tsd-parameters">
790								<li>
791									<h5>category: <span class="tsd-signature-type">string</span></h5>
792								</li>
793							</ul>
794							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
795						</li>
796					</ul>
797				</section>
798				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
799					<a name="setgamename" class="tsd-anchor"></a>
800					<h3>set<wbr>Game<wbr>Name</h3>
801					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
802						<li class="tsd-signature tsd-kind-icon">set<wbr>Game<wbr>Name<span class="tsd-signature-symbol">(</span>game<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
803					</ul>
804					<ul class="tsd-descriptions">
805						<li class="tsd-description">
806							<aside class="tsd-sources">
807								<p>Inherited from <a href="runrefmut.html">RunRefMut</a>.<a href="runrefmut.html#setgamename">setGameName</a></p>
808								<ul>
809									<li>Defined in livesplit_core.ts:4147</li>
810								</ul>
811							</aside>
812							<div class="tsd-comment tsd-typography">
813								<div class="lead">
814									<p>Sets the name of the game this Run is for.</p>
815								</div>
816							</div>
817							<h4 class="tsd-parameters-title">Parameters</h4>
818							<ul class="tsd-parameters">
819								<li>
820									<h5>game: <span class="tsd-signature-type">string</span></h5>
821								</li>
822							</ul>
823							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
824						</li>
825					</ul>
826				</section>
827				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
828					<a name="with" class="tsd-anchor"></a>
829					<h3>with</h3>
830					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
831						<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>
832					</ul>
833					<ul class="tsd-descriptions">
834						<li class="tsd-description">
835							<aside class="tsd-sources">
836								<ul>
837									<li>Defined in livesplit_core.ts:4184</li>
838								</ul>
839							</aside>
840							<div class="tsd-comment tsd-typography">
841								<div class="lead">
842									<p>Allows for scoped usage of the object. The object is guaranteed to get
843										disposed once this function returns. You are free to dispose the object
844										early yourself anywhere within the scope. The scope&#39;s return value gets
845									carried to the outside of this function.</p>
846								</div>
847							</div>
848							<h4 class="tsd-type-parameters-title">Type parameters</h4>
849							<ul class="tsd-type-parameters">
850								<li>
851									<h4>T</h4>
852								</li>
853							</ul>
854							<h4 class="tsd-parameters-title">Parameters</h4>
855							<ul class="tsd-parameters">
856								<li>
857									<h5>closure: <span class="tsd-signature-type">function</span></h5>
858									<ul class="tsd-parameters">
859										<li class="tsd-parameter-siganture">
860											<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
861												<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="run.html" class="tsd-signature-type">Run</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
862											</ul>
863											<ul class="tsd-descriptions">
864												<li class="tsd-description">
865													<h4 class="tsd-parameters-title">Parameters</h4>
866													<ul class="tsd-parameters">
867														<li>
868															<h5>obj: <a href="run.html" class="tsd-signature-type">Run</a></h5>
869														</li>
870													</ul>
871													<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
872												</li>
873											</ul>
874										</li>
875									</ul>
876								</li>
877							</ul>
878							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
879						</li>
880					</ul>
881				</section>
882				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
883					<a name="new" class="tsd-anchor"></a>
884					<h3><span class="tsd-flag ts-flagStatic">Static</span> new</h3>
885					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
886						<li class="tsd-signature tsd-kind-icon">new<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="run.html" class="tsd-signature-type">Run</a></li>
887					</ul>
888					<ul class="tsd-descriptions">
889						<li class="tsd-description">
890							<aside class="tsd-sources">
891								<ul>
892									<li>Defined in livesplit_core.ts:4205</li>
893								</ul>
894							</aside>
895							<div class="tsd-comment tsd-typography">
896								<div class="lead">
897									<p>Creates a new Run object with no segments.</p>
898								</div>
899							</div>
900							<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
901						</li>
902					</ul>
903				</section>
904				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
905					<a name="parse" class="tsd-anchor"></a>
906					<h3><span class="tsd-flag ts-flagStatic">Static</span> parse</h3>
907					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
908						<li class="tsd-signature tsd-kind-icon">parse<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, loadFiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></li>
909					</ul>
910					<ul class="tsd-descriptions">
911						<li class="tsd-description">
912							<aside class="tsd-sources">
913								<ul>
914									<li>Defined in livesplit_core.ts:4217</li>
915								</ul>
916							</aside>
917							<div class="tsd-comment tsd-typography">
918								<div class="lead">
919									<p>Attempts to parse a splits file from an array by invoking the corresponding
920										parser for the file format detected. A path to the splits file can be
921										provided, which helps saving the splits file again later. Additionally you
922										need to specify if additional files, like external images are allowed to be
923										loaded. If you are using livesplit-core in a server-like environment, set
924									this to false. Only client-side applications should set this to true.</p>
925								</div>
926							</div>
927							<h4 class="tsd-parameters-title">Parameters</h4>
928							<ul class="tsd-parameters">
929								<li>
930									<h5>data: <span class="tsd-signature-type">number</span></h5>
931								</li>
932								<li>
933									<h5>length: <span class="tsd-signature-type">number</span></h5>
934								</li>
935								<li>
936									<h5>path: <span class="tsd-signature-type">string</span></h5>
937								</li>
938								<li>
939									<h5>loadFiles: <span class="tsd-signature-type">boolean</span></h5>
940								</li>
941							</ul>
942							<h4 class="tsd-returns-title">Returns <a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></h4>
943						</li>
944					</ul>
945				</section>
946				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
947					<a name="parsearray" class="tsd-anchor"></a>
948					<h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>Array</h3>
949					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
950						<li class="tsd-signature tsd-kind-icon">parse<wbr>Array<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Int8Array</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, loadFiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></li>
951					</ul>
952					<ul class="tsd-descriptions">
953						<li class="tsd-description">
954							<aside class="tsd-sources">
955								<ul>
956									<li>Defined in livesplit_core.ts:4235</li>
957								</ul>
958							</aside>
959							<h4 class="tsd-parameters-title">Parameters</h4>
960							<ul class="tsd-parameters">
961								<li>
962									<h5>data: <span class="tsd-signature-type">Int8Array</span></h5>
963								</li>
964								<li>
965									<h5>path: <span class="tsd-signature-type">string</span></h5>
966								</li>
967								<li>
968									<h5>loadFiles: <span class="tsd-signature-type">boolean</span></h5>
969								</li>
970							</ul>
971							<h4 class="tsd-returns-title">Returns <a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></h4>
972						</li>
973					</ul>
974				</section>
975				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
976					<a name="parsefilehandle" class="tsd-anchor"></a>
977					<h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>File<wbr>Handle</h3>
978					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
979						<li class="tsd-signature tsd-kind-icon">parse<wbr>File<wbr>Handle<span class="tsd-signature-symbol">(</span>handle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, loadFiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></li>
980					</ul>
981					<ul class="tsd-descriptions">
982						<li class="tsd-description">
983							<aside class="tsd-sources">
984								<ul>
985									<li>Defined in livesplit_core.ts:4231</li>
986								</ul>
987							</aside>
988							<div class="tsd-comment tsd-typography">
989								<div class="lead">
990									<p>Attempts to parse a splits file from a file by invoking the corresponding
991										parser for the file format detected. A path to the splits file can be
992										provided, which helps saving the splits file again later. Additionally you
993										need to specify if additional files, like external images are allowed to be
994										loaded. If you are using livesplit-core in a server-like environment, set
995										this to false. Only client-side applications should set this to true. On
996										Unix you pass a file descriptor to this function. On Windows you pass a file
997									handle to this function. The file descriptor / handle does not get closed.</p>
998								</div>
999							</div>
1000							<h4 class="tsd-parameters-title">Parameters</h4>
1001							<ul class="tsd-parameters">
1002								<li>
1003									<h5>handle: <span class="tsd-signature-type">number</span></h5>
1004								</li>
1005								<li>
1006									<h5>path: <span class="tsd-signature-type">string</span></h5>
1007								</li>
1008								<li>
1009									<h5>loadFiles: <span class="tsd-signature-type">boolean</span></h5>
1010								</li>
1011							</ul>
1012							<h4 class="tsd-returns-title">Returns <a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></h4>
1013						</li>
1014					</ul>
1015				</section>
1016				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
1017					<a name="parsestring" class="tsd-anchor"></a>
1018					<h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>String</h3>
1019					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
1020						<li class="tsd-signature tsd-kind-icon">parse<wbr>String<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, loadFiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></li>
1021					</ul>
1022					<ul class="tsd-descriptions">
1023						<li class="tsd-description">
1024							<aside class="tsd-sources">
1025								<ul>
1026									<li>Defined in livesplit_core.ts:4245</li>
1027								</ul>
1028							</aside>
1029							<h4 class="tsd-parameters-title">Parameters</h4>
1030							<ul class="tsd-parameters">
1031								<li>
1032									<h5>text: <span class="tsd-signature-type">string</span></h5>
1033								</li>
1034								<li>
1035									<h5>path: <span class="tsd-signature-type">string</span></h5>
1036								</li>
1037								<li>
1038									<h5>loadFiles: <span class="tsd-signature-type">boolean</span></h5>
1039								</li>
1040							</ul>
1041							<h4 class="tsd-returns-title">Returns <a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a></h4>
1042						</li>
1043					</ul>
1044				</section>
1045			</section>
1046		</div>
1047		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
1048			<nav class="tsd-navigation primary">
1049				<ul>
1050					<li class="globals  ">
1051						<a href="../globals.html"><em>Globals</em></a>
1052					</li>
1053				</ul>
1054			</nav>
1055			<nav class="tsd-navigation secondary menu-sticky">
1056				<ul class="before-current">
1057				</ul>
1058				<ul class="current">
1059					<li class="current tsd-kind-class">
1060						<a href="run.html" class="tsd-kind-icon">Run</a>
1061						<ul>
1062							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
1063								<a href="run.html#constructor" class="tsd-kind-icon">constructor</a>
1064							</li>
1065							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
1066								<a href="run.html#ptr" class="tsd-kind-icon">ptr</a>
1067							</li>
1068							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1069								<a href="run.html#attemptcount" class="tsd-kind-icon">attempt<wbr>Count</a>
1070							</li>
1071							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1072								<a href="run.html#attempthistoryindex" class="tsd-kind-icon">attempt<wbr>History<wbr>Index</a>
1073							</li>
1074							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1075								<a href="run.html#attempthistorylen" class="tsd-kind-icon">attempt<wbr>History<wbr>Len</a>
1076							</li>
1077							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1078								<a href="run.html#autosplittersettings" class="tsd-kind-icon">auto<wbr>Splitter<wbr>Settings</a>
1079							</li>
1080							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1081								<a href="run.html#categoryname" class="tsd-kind-icon">category<wbr>Name</a>
1082							</li>
1083							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1084								<a href="run.html#clone" class="tsd-kind-icon">clone</a>
1085							</li>
1086							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1087								<a href="run.html#customcomparison" class="tsd-kind-icon">custom<wbr>Comparison</a>
1088							</li>
1089							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1090								<a href="run.html#customcomparisonslen" class="tsd-kind-icon">custom<wbr>Comparisons<wbr>Len</a>
1091							</li>
1092							<li class=" tsd-kind-method tsd-parent-kind-class">
1093								<a href="run.html#dispose" class="tsd-kind-icon">dispose</a>
1094							</li>
1095							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1096								<a href="run.html#extendedcategoryname" class="tsd-kind-icon">extended<wbr>Category<wbr>Name</a>
1097							</li>
1098							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1099								<a href="run.html#extendedfilename" class="tsd-kind-icon">extended<wbr>File<wbr>Name</a>
1100							</li>
1101							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1102								<a href="run.html#extendedname" class="tsd-kind-icon">extended<wbr>Name</a>
1103							</li>
1104							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1105								<a href="run.html#gameicon" class="tsd-kind-icon">game<wbr>Icon</a>
1106							</li>
1107							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1108								<a href="run.html#gamename" class="tsd-kind-icon">game<wbr>Name</a>
1109							</li>
1110							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1111								<a href="run.html#hasbeenmodified" class="tsd-kind-icon">has<wbr>Been<wbr>Modified</a>
1112							</li>
1113							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1114								<a href="run.html#len" class="tsd-kind-icon">len</a>
1115							</li>
1116							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1117								<a href="run.html#markasmodified" class="tsd-kind-icon">mark<wbr>AsModified</a>
1118							</li>
1119							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1120								<a href="run.html#metadata" class="tsd-kind-icon">metadata</a>
1121							</li>
1122							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1123								<a href="run.html#offset" class="tsd-kind-icon">offset</a>
1124							</li>
1125							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1126								<a href="run.html#pushsegment" class="tsd-kind-icon">push<wbr>Segment</a>
1127							</li>
1128							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1129								<a href="run.html#saveaslss" class="tsd-kind-icon">save<wbr>AsLss</a>
1130							</li>
1131							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1132								<a href="run.html#segment" class="tsd-kind-icon">segment</a>
1133							</li>
1134							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1135								<a href="run.html#setcategoryname" class="tsd-kind-icon">set<wbr>Category<wbr>Name</a>
1136							</li>
1137							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1138								<a href="run.html#setgamename" class="tsd-kind-icon">set<wbr>Game<wbr>Name</a>
1139							</li>
1140							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
1141								<a href="run.html#with" class="tsd-kind-icon">with</a>
1142							</li>
1143							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
1144								<a href="run.html#new" class="tsd-kind-icon">new</a>
1145							</li>
1146							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
1147								<a href="run.html#parse" class="tsd-kind-icon">parse</a>
1148							</li>
1149							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
1150								<a href="run.html#parsearray" class="tsd-kind-icon">parse<wbr>Array</a>
1151							</li>
1152							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
1153								<a href="run.html#parsefilehandle" class="tsd-kind-icon">parse<wbr>File<wbr>Handle</a>
1154							</li>
1155							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
1156								<a href="run.html#parsestring" class="tsd-kind-icon">parse<wbr>String</a>
1157							</li>
1158						</ul>
1159					</li>
1160				</ul>
1161				<ul class="after-current">
1162				</ul>
1163			</nav>
1164		</div>
1165	</div>
1166</div>
1167<footer class="with-border-bottom">
1168	<div class="container">
1169		<h2>Legend</h2>
1170		<div class="tsd-legend-group">
1171			<ul class="tsd-legend">
1172				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
1173				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
1174				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
1175				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
1176				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
1177				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
1178				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
1179			</ul>
1180			<ul class="tsd-legend">
1181				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
1182				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
1183				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
1184				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
1185			</ul>
1186			<ul class="tsd-legend">
1187				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
1188				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
1189				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
1190				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
1191				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
1192				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
1193			</ul>
1194			<ul class="tsd-legend">
1195				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
1196				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
1197				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
1198				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
1199				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
1200				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
1201				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
1202			</ul>
1203			<ul class="tsd-legend">
1204				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
1205				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
1206				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
1207				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
1208			</ul>
1209			<ul class="tsd-legend">
1210				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
1211				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
1212				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
1213			</ul>
1214			<ul class="tsd-legend">
1215				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
1216				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
1217				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
1218			</ul>
1219			<ul class="tsd-legend">
1220				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
1221				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
1222			</ul>
1223		</div>
1224	</div>
1225</footer>
1226<div class="container tsd-generator">
1227	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
1228</div>
1229<div class="overlay"></div>
1230<script src="../assets/js/main.js"></script>
1231<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
1232</body>
1233</html>