fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
20.1 KiB407 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>RunMetadataRefMut | 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="runmetadatarefmut.html">RunMetadataRefMut</a>
60				</li>
61			</ul>
62			<h1>Class RunMetadataRefMut</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 Run Metadata stores additional information about a run, like the
73						platform and region of the game. All of this information is optional.</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="runmetadataref.html" class="tsd-signature-type">RunMetadataRef</a>
82						<ul class="tsd-hierarchy">
83							<li>
84								<span class="target">RunMetadataRefMut</span>
85								<ul class="tsd-hierarchy">
86									<li>
87										<a href="runmetadata.html" class="tsd-signature-type">RunMetadata</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="runmetadatarefmut.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="runmetadatarefmut.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="runmetadatarefmut.html#platformname" class="tsd-kind-icon">platform<wbr>Name</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatarefmut.html#regionname" class="tsd-kind-icon">region<wbr>Name</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatarefmut.html#runid" class="tsd-kind-icon">run<wbr>Id</a></li>
117								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatarefmut.html#usesemulator" class="tsd-kind-icon">uses<wbr>Emulator</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatarefmut.html#variables" class="tsd-kind-icon">variables</a></li>
119							</ul>
120						</section>
121					</div>
122				</section>
123			</section>
124			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
125				<h2>Constructors</h2>
126				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
127					<a name="constructor" class="tsd-anchor"></a>
128					<h3>constructor</h3>
129					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
130						<li class="tsd-signature tsd-kind-icon">new <wbr>Run<wbr>Metadata<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="runmetadatarefmut.html" class="tsd-signature-type">RunMetadataRefMut</a></li>
131					</ul>
132					<ul class="tsd-descriptions">
133						<li class="tsd-description">
134							<aside class="tsd-sources">
135								<p>Inherited from <a href="runmetadataref.html">RunMetadataRef</a>.<a href="runmetadataref.html#constructor">constructor</a></p>
136								<ul>
137									<li>Defined in livesplit_core.ts:4840</li>
138								</ul>
139							</aside>
140							<div class="tsd-comment tsd-typography">
141								<div class="lead">
142									<p>This constructor is an implementation detail. Do not use this.</p>
143								</div>
144							</div>
145							<h4 class="tsd-parameters-title">Parameters</h4>
146							<ul class="tsd-parameters">
147								<li>
148									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
149								</li>
150							</ul>
151							<h4 class="tsd-returns-title">Returns <a href="runmetadatarefmut.html" class="tsd-signature-type">RunMetadataRefMut</a></h4>
152						</li>
153					</ul>
154				</section>
155			</section>
156			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
157				<h2>Properties</h2>
158				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
159					<a name="ptr" class="tsd-anchor"></a>
160					<h3>ptr</h3>
161					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
162					<aside class="tsd-sources">
163						<p>Inherited from <a href="runmetadataref.html">RunMetadataRef</a>.<a href="runmetadataref.html#ptr">ptr</a></p>
164						<ul>
165							<li>Defined in livesplit_core.ts:4783</li>
166						</ul>
167					</aside>
168				</section>
169			</section>
170			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
171				<h2>Methods</h2>
172				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
173					<a name="platformname" class="tsd-anchor"></a>
174					<h3>platform<wbr>Name</h3>
175					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
176						<li class="tsd-signature tsd-kind-icon">platform<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>
177					</ul>
178					<ul class="tsd-descriptions">
179						<li class="tsd-description">
180							<aside class="tsd-sources">
181								<p>Inherited from <a href="runmetadataref.html">RunMetadataRef</a>.<a href="runmetadataref.html#platformname">platformName</a></p>
182								<ul>
183									<li>Defined in livesplit_core.ts:4801</li>
184								</ul>
185							</aside>
186							<div class="tsd-comment tsd-typography">
187								<div class="lead">
188									<p>Accesses the name of the platform this game is run on. This may be empty
189									if it&#39;s not specified.</p>
190								</div>
191							</div>
192							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="regionname" class="tsd-anchor"></a>
198					<h3>region<wbr>Name</h3>
199					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
200						<li class="tsd-signature tsd-kind-icon">region<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>
201					</ul>
202					<ul class="tsd-descriptions">
203						<li class="tsd-description">
204							<aside class="tsd-sources">
205								<p>Inherited from <a href="runmetadataref.html">RunMetadataRef</a>.<a href="runmetadataref.html#regionname">regionName</a></p>
206								<ul>
207									<li>Defined in livesplit_core.ts:4823</li>
208								</ul>
209							</aside>
210							<div class="tsd-comment tsd-typography">
211								<div class="lead">
212									<p>Accesses the name of the region this game is from. This may be empty if
213									it&#39;s not specified.</p>
214								</div>
215							</div>
216							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
217						</li>
218					</ul>
219				</section>
220				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
221					<a name="runid" class="tsd-anchor"></a>
222					<h3>run<wbr>Id</h3>
223					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
224						<li class="tsd-signature tsd-kind-icon">run<wbr>Id<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>
225					</ul>
226					<ul class="tsd-descriptions">
227						<li class="tsd-description">
228							<aside class="tsd-sources">
229								<p>Inherited from <a href="runmetadataref.html">RunMetadataRef</a>.<a href="runmetadataref.html#runid">runId</a></p>
230								<ul>
231									<li>Defined in livesplit_core.ts:4790</li>
232								</ul>
233							</aside>
234							<div class="tsd-comment tsd-typography">
235								<div class="lead">
236									<p>Accesses the speedrun.com Run ID of the run. This Run ID specify which
237										Record on speedrun.com this run is associated with. This should be
238										changed once the Personal Best doesn&#39;t match up with that record
239									anymore. This may be empty if there&#39;s no association.</p>
240								</div>
241							</div>
242							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></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="usesemulator" class="tsd-anchor"></a>
248					<h3>uses<wbr>Emulator</h3>
249					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
250						<li class="tsd-signature tsd-kind-icon">uses<wbr>Emulator<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>
251					</ul>
252					<ul class="tsd-descriptions">
253						<li class="tsd-description">
254							<aside class="tsd-sources">
255								<p>Inherited from <a href="runmetadataref.html">RunMetadataRef</a>.<a href="runmetadataref.html#usesemulator">usesEmulator</a></p>
256								<ul>
257									<li>Defined in livesplit_core.ts:4812</li>
258								</ul>
259							</aside>
260							<div class="tsd-comment tsd-typography">
261								<div class="lead">
262									<p>Returns true if this speedrun is done on an emulator. However false
263									may also indicate that this information is simply not known.</p>
264								</div>
265							</div>
266							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
267						</li>
268					</ul>
269				</section>
270				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
271					<a name="variables" class="tsd-anchor"></a>
272					<h3>variables</h3>
273					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
274						<li class="tsd-signature tsd-kind-icon">variables<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="runmetadatavariablesiter.html" class="tsd-signature-type">RunMetadataVariablesIter</a></li>
275					</ul>
276					<ul class="tsd-descriptions">
277						<li class="tsd-description">
278							<aside class="tsd-sources">
279								<p>Inherited from <a href="runmetadataref.html">RunMetadataRef</a>.<a href="runmetadataref.html#variables">variables</a></p>
280								<ul>
281									<li>Defined in livesplit_core.ts:4834</li>
282								</ul>
283							</aside>
284							<div class="tsd-comment tsd-typography">
285								<div class="lead">
286									<p>Returns an iterator iterating over all the variables and their values
287									that have been specified.</p>
288								</div>
289							</div>
290							<h4 class="tsd-returns-title">Returns <a href="runmetadatavariablesiter.html" class="tsd-signature-type">RunMetadataVariablesIter</a></h4>
291						</li>
292					</ul>
293				</section>
294			</section>
295		</div>
296		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
297			<nav class="tsd-navigation primary">
298				<ul>
299					<li class="globals  ">
300						<a href="../globals.html"><em>Globals</em></a>
301					</li>
302				</ul>
303			</nav>
304			<nav class="tsd-navigation secondary menu-sticky">
305				<ul class="before-current">
306				</ul>
307				<ul class="current">
308					<li class="current tsd-kind-class">
309						<a href="runmetadatarefmut.html" class="tsd-kind-icon">Run<wbr>Metadata<wbr>Ref<wbr>Mut</a>
310						<ul>
311							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
312								<a href="runmetadatarefmut.html#constructor" class="tsd-kind-icon">constructor</a>
313							</li>
314							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
315								<a href="runmetadatarefmut.html#ptr" class="tsd-kind-icon">ptr</a>
316							</li>
317							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
318								<a href="runmetadatarefmut.html#platformname" class="tsd-kind-icon">platform<wbr>Name</a>
319							</li>
320							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
321								<a href="runmetadatarefmut.html#regionname" class="tsd-kind-icon">region<wbr>Name</a>
322							</li>
323							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
324								<a href="runmetadatarefmut.html#runid" class="tsd-kind-icon">run<wbr>Id</a>
325							</li>
326							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
327								<a href="runmetadatarefmut.html#usesemulator" class="tsd-kind-icon">uses<wbr>Emulator</a>
328							</li>
329							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
330								<a href="runmetadatarefmut.html#variables" class="tsd-kind-icon">variables</a>
331							</li>
332						</ul>
333					</li>
334				</ul>
335				<ul class="after-current">
336				</ul>
337			</nav>
338		</div>
339	</div>
340</div>
341<footer class="with-border-bottom">
342	<div class="container">
343		<h2>Legend</h2>
344		<div class="tsd-legend-group">
345			<ul class="tsd-legend">
346				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
347				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
348				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
349				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
350				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
351				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
352				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
353			</ul>
354			<ul class="tsd-legend">
355				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
356				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
357				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
358				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
359			</ul>
360			<ul class="tsd-legend">
361				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
362				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
363				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
364				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
365				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
366				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
367			</ul>
368			<ul class="tsd-legend">
369				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
370				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
371				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
372				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
373				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
374				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
375				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
376			</ul>
377			<ul class="tsd-legend">
378				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
379				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
380				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
381				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
382			</ul>
383			<ul class="tsd-legend">
384				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
385				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
386				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
387			</ul>
388			<ul class="tsd-legend">
389				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
390				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
391				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
392			</ul>
393			<ul class="tsd-legend">
394				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
395				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
396			</ul>
397		</div>
398	</div>
399</footer>
400<div class="container tsd-generator">
401	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
402</div>
403<div class="overlay"></div>
404<script src="../assets/js/main.js"></script>
405<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
406</body>
407</html>