fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
19.4 KiB402 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>RunMetadataVariable | 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="runmetadatavariable.html">RunMetadataVariable</a>
60				</li>
61			</ul>
62			<h1>Class RunMetadataVariable</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 Metadata variable is an arbitrary key value pair storing additional
73							information about the category. An example of this may be whether Amiibos
74						are used in the category.</p>
75					</div>
76				</div>
77			</section>
78			<section class="tsd-panel tsd-hierarchy">
79				<h3>Hierarchy</h3>
80				<ul class="tsd-hierarchy">
81					<li>
82						<a href="runmetadatavariablerefmut.html" class="tsd-signature-type">RunMetadataVariableRefMut</a>
83						<ul class="tsd-hierarchy">
84							<li>
85								<span class="target">RunMetadataVariable</span>
86							</li>
87						</ul>
88					</li>
89				</ul>
90			</section>
91			<section class="tsd-panel-group tsd-index-group">
92				<h2>Index</h2>
93				<section class="tsd-panel tsd-index-panel">
94					<div class="tsd-index-content">
95						<section class="tsd-index-section tsd-is-inherited">
96							<h3>Constructors</h3>
97							<ul class="tsd-index-list">
98								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatavariable.html#constructor" class="tsd-kind-icon">constructor</a></li>
99							</ul>
100						</section>
101						<section class="tsd-index-section tsd-is-inherited">
102							<h3>Properties</h3>
103							<ul class="tsd-index-list">
104								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatavariable.html#ptr" class="tsd-kind-icon">ptr</a></li>
105							</ul>
106						</section>
107						<section class="tsd-index-section ">
108							<h3>Methods</h3>
109							<ul class="tsd-index-list">
110								<li class="tsd-kind-method tsd-parent-kind-class"><a href="runmetadatavariable.html#dispose" class="tsd-kind-icon">dispose</a></li>
111								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatavariable.html#name" class="tsd-kind-icon">name</a></li>
112								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="runmetadatavariable.html#value" class="tsd-kind-icon">value</a></li>
113								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="runmetadatavariable.html#with" class="tsd-kind-icon">with</a></li>
114							</ul>
115						</section>
116					</div>
117				</section>
118			</section>
119			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
120				<h2>Constructors</h2>
121				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
122					<a name="constructor" class="tsd-anchor"></a>
123					<h3>constructor</h3>
124					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
125						<li class="tsd-signature tsd-kind-icon">new <wbr>Run<wbr>Metadata<wbr>Variable<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="runmetadatavariable.html" class="tsd-signature-type">RunMetadataVariable</a></li>
126					</ul>
127					<ul class="tsd-descriptions">
128						<li class="tsd-description">
129							<aside class="tsd-sources">
130								<p>Inherited from <a href="runmetadatavariableref.html">RunMetadataVariableRef</a>.<a href="runmetadatavariableref.html#constructor">constructor</a></p>
131								<ul>
132									<li>Defined in livesplit_core.ts:4912</li>
133								</ul>
134							</aside>
135							<div class="tsd-comment tsd-typography">
136								<div class="lead">
137									<p>This constructor is an implementation detail. Do not use this.</p>
138								</div>
139							</div>
140							<h4 class="tsd-parameters-title">Parameters</h4>
141							<ul class="tsd-parameters">
142								<li>
143									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
144								</li>
145							</ul>
146							<h4 class="tsd-returns-title">Returns <a href="runmetadatavariable.html" class="tsd-signature-type">RunMetadataVariable</a></h4>
147						</li>
148					</ul>
149				</section>
150			</section>
151			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
152				<h2>Properties</h2>
153				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
154					<a name="ptr" class="tsd-anchor"></a>
155					<h3>ptr</h3>
156					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
157					<aside class="tsd-sources">
158						<p>Inherited from <a href="runmetadatavariableref.html">RunMetadataVariableRef</a>.<a href="runmetadatavariableref.html#ptr">ptr</a></p>
159						<ul>
160							<li>Defined in livesplit_core.ts:4892</li>
161						</ul>
162					</aside>
163				</section>
164			</section>
165			<section class="tsd-panel-group tsd-member-group ">
166				<h2>Methods</h2>
167				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
168					<a name="dispose" class="tsd-anchor"></a>
169					<h3>dispose</h3>
170					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
171						<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>
172					</ul>
173					<ul class="tsd-descriptions">
174						<li class="tsd-description">
175							<aside class="tsd-sources">
176								<ul>
177									<li>Defined in livesplit_core.ts:4953</li>
178								</ul>
179							</aside>
180							<div class="tsd-comment tsd-typography">
181								<div class="lead">
182									<p>Disposes the object, allowing it to clean up all of its memory. You need
183										to call this for every object that you don&#39;t use anymore and hasn&#39;t
184									already been disposed.</p>
185								</div>
186							</div>
187							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
188						</li>
189					</ul>
190				</section>
191				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
192					<a name="name" class="tsd-anchor"></a>
193					<h3>name</h3>
194					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
195						<li class="tsd-signature tsd-kind-icon">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>
196					</ul>
197					<ul class="tsd-descriptions">
198						<li class="tsd-description">
199							<aside class="tsd-sources">
200								<p>Inherited from <a href="runmetadatavariableref.html">RunMetadataVariableRef</a>.<a href="runmetadatavariableref.html#name">name</a></p>
201								<ul>
202									<li>Defined in livesplit_core.ts:4896</li>
203								</ul>
204							</aside>
205							<div class="tsd-comment tsd-typography">
206								<div class="lead">
207									<p>Accesses the name of this Run Metadata variable.</p>
208								</div>
209							</div>
210							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="value" class="tsd-anchor"></a>
216					<h3>value</h3>
217					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
218						<li class="tsd-signature tsd-kind-icon">value<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>
219					</ul>
220					<ul class="tsd-descriptions">
221						<li class="tsd-description">
222							<aside class="tsd-sources">
223								<p>Inherited from <a href="runmetadatavariableref.html">RunMetadataVariableRef</a>.<a href="runmetadatavariableref.html#value">value</a></p>
224								<ul>
225									<li>Defined in livesplit_core.ts:4906</li>
226								</ul>
227							</aside>
228							<div class="tsd-comment tsd-typography">
229								<div class="lead">
230									<p>Accesses the value of this Run Metadata variable.</p>
231								</div>
232							</div>
233							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
234						</li>
235					</ul>
236				</section>
237				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
238					<a name="with" class="tsd-anchor"></a>
239					<h3>with</h3>
240					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
241						<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>
242					</ul>
243					<ul class="tsd-descriptions">
244						<li class="tsd-description">
245							<aside class="tsd-sources">
246								<ul>
247									<li>Defined in livesplit_core.ts:4941</li>
248								</ul>
249							</aside>
250							<div class="tsd-comment tsd-typography">
251								<div class="lead">
252									<p>Allows for scoped usage of the object. The object is guaranteed to get
253										disposed once this function returns. You are free to dispose the object
254										early yourself anywhere within the scope. The scope&#39;s return value gets
255									carried to the outside of this function.</p>
256								</div>
257							</div>
258							<h4 class="tsd-type-parameters-title">Type parameters</h4>
259							<ul class="tsd-type-parameters">
260								<li>
261									<h4>T</h4>
262								</li>
263							</ul>
264							<h4 class="tsd-parameters-title">Parameters</h4>
265							<ul class="tsd-parameters">
266								<li>
267									<h5>closure: <span class="tsd-signature-type">function</span></h5>
268									<ul class="tsd-parameters">
269										<li class="tsd-parameter-siganture">
270											<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
271												<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="runmetadatavariable.html" class="tsd-signature-type">RunMetadataVariable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
272											</ul>
273											<ul class="tsd-descriptions">
274												<li class="tsd-description">
275													<h4 class="tsd-parameters-title">Parameters</h4>
276													<ul class="tsd-parameters">
277														<li>
278															<h5>obj: <a href="runmetadatavariable.html" class="tsd-signature-type">RunMetadataVariable</a></h5>
279														</li>
280													</ul>
281													<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
282												</li>
283											</ul>
284										</li>
285									</ul>
286								</li>
287							</ul>
288							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
289						</li>
290					</ul>
291				</section>
292			</section>
293		</div>
294		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
295			<nav class="tsd-navigation primary">
296				<ul>
297					<li class="globals  ">
298						<a href="../globals.html"><em>Globals</em></a>
299					</li>
300				</ul>
301			</nav>
302			<nav class="tsd-navigation secondary menu-sticky">
303				<ul class="before-current">
304				</ul>
305				<ul class="current">
306					<li class="current tsd-kind-class">
307						<a href="runmetadatavariable.html" class="tsd-kind-icon">Run<wbr>Metadata<wbr>Variable</a>
308						<ul>
309							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
310								<a href="runmetadatavariable.html#constructor" class="tsd-kind-icon">constructor</a>
311							</li>
312							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
313								<a href="runmetadatavariable.html#ptr" class="tsd-kind-icon">ptr</a>
314							</li>
315							<li class=" tsd-kind-method tsd-parent-kind-class">
316								<a href="runmetadatavariable.html#dispose" class="tsd-kind-icon">dispose</a>
317							</li>
318							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
319								<a href="runmetadatavariable.html#name" class="tsd-kind-icon">name</a>
320							</li>
321							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
322								<a href="runmetadatavariable.html#value" class="tsd-kind-icon">value</a>
323							</li>
324							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
325								<a href="runmetadatavariable.html#with" class="tsd-kind-icon">with</a>
326							</li>
327						</ul>
328					</li>
329				</ul>
330				<ul class="after-current">
331				</ul>
332			</nav>
333		</div>
334	</div>
335</div>
336<footer class="with-border-bottom">
337	<div class="container">
338		<h2>Legend</h2>
339		<div class="tsd-legend-group">
340			<ul class="tsd-legend">
341				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
342				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
343				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
344				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
345				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
346				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
347				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
348			</ul>
349			<ul class="tsd-legend">
350				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
351				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
352				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
353				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
354			</ul>
355			<ul class="tsd-legend">
356				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
357				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
358				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
359				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
360				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
361				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
362			</ul>
363			<ul class="tsd-legend">
364				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
365				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
366				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
367				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
368				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
369				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
370				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
371			</ul>
372			<ul class="tsd-legend">
373				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
374				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
375				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
376				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
377			</ul>
378			<ul class="tsd-legend">
379				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
380				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
381				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
382			</ul>
383			<ul class="tsd-legend">
384				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
385				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
386				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
387			</ul>
388			<ul class="tsd-legend">
389				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
390				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
391			</ul>
392		</div>
393	</div>
394</footer>
395<div class="container tsd-generator">
396	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
397</div>
398<div class="overlay"></div>
399<script src="../assets/js/main.js"></script>
400<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
401</body>
402</html>