fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
17.2 KiB350 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>ParseRunResultRefMut | 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="parserunresultrefmut.html">ParseRunResultRefMut</a>
60				</li>
61			</ul>
62			<h1>Class ParseRunResultRefMut</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 parsed by the Composite Parser. This contains the Run itself and
73						information about which parser parsed it.</p>
74					</div>
75				</div>
76			</section>
77			<section class="tsd-panel tsd-hierarchy">
78				<h3>Hierarchy</h3>
79				<ul class="tsd-hierarchy">
80					<li>
81						<a href="parserunresultref.html" class="tsd-signature-type">ParseRunResultRef</a>
82						<ul class="tsd-hierarchy">
83							<li>
84								<span class="target">ParseRunResultRefMut</span>
85								<ul class="tsd-hierarchy">
86									<li>
87										<a href="parserunresult.html" class="tsd-signature-type">ParseRunResult</a>
88									</li>
89								</ul>
90							</li>
91						</ul>
92					</li>
93				</ul>
94			</section>
95			<section class="tsd-panel-group tsd-index-group">
96				<h2>Index</h2>
97				<section class="tsd-panel tsd-index-panel">
98					<div class="tsd-index-content">
99						<section class="tsd-index-section tsd-is-inherited">
100							<h3>Constructors</h3>
101							<ul class="tsd-index-list">
102								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="parserunresultrefmut.html#constructor" class="tsd-kind-icon">constructor</a></li>
103							</ul>
104						</section>
105						<section class="tsd-index-section tsd-is-inherited">
106							<h3>Properties</h3>
107							<ul class="tsd-index-list">
108								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="parserunresultrefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
109							</ul>
110						</section>
111						<section class="tsd-index-section tsd-is-inherited">
112							<h3>Methods</h3>
113							<ul class="tsd-index-list">
114								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parserunresultrefmut.html#isgenerictimer" class="tsd-kind-icon">is<wbr>Generic<wbr>Timer</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parserunresultrefmut.html#parsedsuccessfully" class="tsd-kind-icon">parsed<wbr>Successfully</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parserunresultrefmut.html#timerkind" class="tsd-kind-icon">timer<wbr>Kind</a></li>
117							</ul>
118						</section>
119					</div>
120				</section>
121			</section>
122			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
123				<h2>Constructors</h2>
124				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
125					<a name="constructor" class="tsd-anchor"></a>
126					<h3>constructor</h3>
127					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
128						<li class="tsd-signature tsd-kind-icon">new <wbr>Parse<wbr>Run<wbr>Result<wbr>Ref<wbr>Mut<span class="tsd-signature-symbol">(</span>ptr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="parserunresultrefmut.html" class="tsd-signature-type">ParseRunResultRefMut</a></li>
129					</ul>
130					<ul class="tsd-descriptions">
131						<li class="tsd-description">
132							<aside class="tsd-sources">
133								<p>Inherited from <a href="parserunresultref.html">ParseRunResultRef</a>.<a href="parserunresultref.html#constructor">constructor</a></p>
134								<ul>
135									<li>Defined in livesplit_core.ts:3405</li>
136								</ul>
137							</aside>
138							<div class="tsd-comment tsd-typography">
139								<div class="lead">
140									<p>This constructor is an implementation detail. Do not use this.</p>
141								</div>
142							</div>
143							<h4 class="tsd-parameters-title">Parameters</h4>
144							<ul class="tsd-parameters">
145								<li>
146									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
147								</li>
148							</ul>
149							<h4 class="tsd-returns-title">Returns <a href="parserunresultrefmut.html" class="tsd-signature-type">ParseRunResultRefMut</a></h4>
150						</li>
151					</ul>
152				</section>
153			</section>
154			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
155				<h2>Properties</h2>
156				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
157					<a name="ptr" class="tsd-anchor"></a>
158					<h3>ptr</h3>
159					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
160					<aside class="tsd-sources">
161						<p>Inherited from <a href="parserunresultref.html">ParseRunResultRef</a>.<a href="parserunresultref.html#ptr">ptr</a></p>
162						<ul>
163							<li>Defined in livesplit_core.ts:3371</li>
164						</ul>
165					</aside>
166				</section>
167			</section>
168			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
169				<h2>Methods</h2>
170				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
171					<a name="isgenerictimer" class="tsd-anchor"></a>
172					<h3>is<wbr>Generic<wbr>Timer</h3>
173					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
174						<li class="tsd-signature tsd-kind-icon">is<wbr>Generic<wbr>Timer<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>
175					</ul>
176					<ul class="tsd-descriptions">
177						<li class="tsd-description">
178							<aside class="tsd-sources">
179								<p>Inherited from <a href="parserunresultref.html">ParseRunResultRef</a>.<a href="parserunresultref.html#isgenerictimer">isGenericTimer</a></p>
180								<ul>
181									<li>Defined in livesplit_core.ts:3399</li>
182								</ul>
183							</aside>
184							<div class="tsd-comment tsd-typography">
185								<div class="lead">
186									<p>Checks whether the Parser parsed a generic timer. Since a generic timer can
187										have any name, it may clash with the specific timer formats that
188										livesplit-core supports. With this function you can determine if a generic
189									timer format was parsed, instead of one of the more specific timer formats.</p>
190								</div>
191							</div>
192							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
193						</li>
194					</ul>
195				</section>
196				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
197					<a name="parsedsuccessfully" class="tsd-anchor"></a>
198					<h3>parsed<wbr>Successfully</h3>
199					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
200						<li class="tsd-signature tsd-kind-icon">parsed<wbr>Successfully<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>
201					</ul>
202					<ul class="tsd-descriptions">
203						<li class="tsd-description">
204							<aside class="tsd-sources">
205								<p>Inherited from <a href="parserunresultref.html">ParseRunResultRef</a>.<a href="parserunresultref.html#parsedsuccessfully">parsedSuccessfully</a></p>
206								<ul>
207									<li>Defined in livesplit_core.ts:3375</li>
208								</ul>
209							</aside>
210							<div class="tsd-comment tsd-typography">
211								<div class="lead">
212									<p>Returns true if the Run got parsed successfully. false is returned otherwise.</p>
213								</div>
214							</div>
215							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
216						</li>
217					</ul>
218				</section>
219				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
220					<a name="timerkind" class="tsd-anchor"></a>
221					<h3>timer<wbr>Kind</h3>
222					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
223						<li class="tsd-signature tsd-kind-icon">timer<wbr>Kind<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>
224					</ul>
225					<ul class="tsd-descriptions">
226						<li class="tsd-description">
227							<aside class="tsd-sources">
228								<p>Inherited from <a href="parserunresultref.html">ParseRunResultRef</a>.<a href="parserunresultref.html#timerkind">timerKind</a></p>
229								<ul>
230									<li>Defined in livesplit_core.ts:3386</li>
231								</ul>
232							</aside>
233							<div class="tsd-comment tsd-typography">
234								<div class="lead">
235									<p>Accesses the name of the Parser that parsed the Run. You may not call this
236									if the Run wasn&#39;t parsed successfully.</p>
237								</div>
238							</div>
239							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
240						</li>
241					</ul>
242				</section>
243			</section>
244		</div>
245		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
246			<nav class="tsd-navigation primary">
247				<ul>
248					<li class="globals  ">
249						<a href="../globals.html"><em>Globals</em></a>
250					</li>
251				</ul>
252			</nav>
253			<nav class="tsd-navigation secondary menu-sticky">
254				<ul class="before-current">
255				</ul>
256				<ul class="current">
257					<li class="current tsd-kind-class">
258						<a href="parserunresultrefmut.html" class="tsd-kind-icon">Parse<wbr>Run<wbr>Result<wbr>Ref<wbr>Mut</a>
259						<ul>
260							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
261								<a href="parserunresultrefmut.html#constructor" class="tsd-kind-icon">constructor</a>
262							</li>
263							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
264								<a href="parserunresultrefmut.html#ptr" class="tsd-kind-icon">ptr</a>
265							</li>
266							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
267								<a href="parserunresultrefmut.html#isgenerictimer" class="tsd-kind-icon">is<wbr>Generic<wbr>Timer</a>
268							</li>
269							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
270								<a href="parserunresultrefmut.html#parsedsuccessfully" class="tsd-kind-icon">parsed<wbr>Successfully</a>
271							</li>
272							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
273								<a href="parserunresultrefmut.html#timerkind" class="tsd-kind-icon">timer<wbr>Kind</a>
274							</li>
275						</ul>
276					</li>
277				</ul>
278				<ul class="after-current">
279				</ul>
280			</nav>
281		</div>
282	</div>
283</div>
284<footer class="with-border-bottom">
285	<div class="container">
286		<h2>Legend</h2>
287		<div class="tsd-legend-group">
288			<ul class="tsd-legend">
289				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
290				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
291				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
292				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
293				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
294				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
295				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
296			</ul>
297			<ul class="tsd-legend">
298				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
299				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
300				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
301				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
302			</ul>
303			<ul class="tsd-legend">
304				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
305				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
306				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
307				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
308				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
309				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
310			</ul>
311			<ul class="tsd-legend">
312				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
313				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
314				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
315				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
316				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
317				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
318				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
319			</ul>
320			<ul class="tsd-legend">
321				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
322				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
323				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
324				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
325			</ul>
326			<ul class="tsd-legend">
327				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
328				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
329				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
330			</ul>
331			<ul class="tsd-legend">
332				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
333				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
334				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
335			</ul>
336			<ul class="tsd-legend">
337				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
338				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
339			</ul>
340		</div>
341	</div>
342</footer>
343<div class="container tsd-generator">
344	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
345</div>
346<div class="overlay"></div>
347<script src="../assets/js/main.js"></script>
348<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
349</body>
350</html>