fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
18.2 KiB387 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>RunEditorStateJson | 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="runeditorstatejson.html">RunEditorStateJson</a>
60				</li>
61			</ul>
62			<h1>Interface RunEditorStateJson</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>Represents the current state of the Run Editor in order to visualize it
73						properly.</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						<span class="target">RunEditorStateJson</span>
82					</li>
83				</ul>
84			</section>
85			<section class="tsd-panel-group tsd-index-group">
86				<h2>Index</h2>
87				<section class="tsd-panel tsd-index-panel">
88					<div class="tsd-index-content">
89						<section class="tsd-index-section ">
90							<h3>Properties</h3>
91							<ul class="tsd-index-list">
92								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#attempts" class="tsd-kind-icon">attempts</a></li>
93								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#buttons" class="tsd-kind-icon">buttons</a></li>
94								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#category" class="tsd-kind-icon">category</a></li>
95								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#comparison_names" class="tsd-kind-icon">comparison_<wbr>names</a></li>
96								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#game" class="tsd-kind-icon">game</a></li>
97								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#icon_change" class="tsd-kind-icon">icon_<wbr>change</a></li>
98								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#metadata" class="tsd-kind-icon">metadata</a></li>
99								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#offset" class="tsd-kind-icon">offset</a></li>
100								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#segments" class="tsd-kind-icon">segments</a></li>
101								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runeditorstatejson.html#timing_method" class="tsd-kind-icon">timing_<wbr>method</a></li>
102							</ul>
103						</section>
104					</div>
105				</section>
106			</section>
107			<section class="tsd-panel-group tsd-member-group ">
108				<h2>Properties</h2>
109				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
110					<a name="attempts" class="tsd-anchor"></a>
111					<h3>attempts</h3>
112					<div class="tsd-signature tsd-kind-icon">attempts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
113					<aside class="tsd-sources">
114						<ul>
115							<li>Defined in livesplit_core.ts:636</li>
116						</ul>
117					</aside>
118					<div class="tsd-comment tsd-typography">
119						<div class="lead">
120							<p>The number of times this Run has been attempted by the runner. This
121							is mostly just a visual number and has no effect on any history.</p>
122						</div>
123					</div>
124				</section>
125				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
126					<a name="buttons" class="tsd-anchor"></a>
127					<h3>buttons</h3>
128					<div class="tsd-signature tsd-kind-icon">buttons<span class="tsd-signature-symbol">:</span> <a href="runeditorbuttonsjson.html" class="tsd-signature-type">RunEditorButtonsJson</a></div>
129					<aside class="tsd-sources">
130						<ul>
131							<li>Defined in livesplit_core.ts:647</li>
132						</ul>
133					</aside>
134					<div class="tsd-comment tsd-typography">
135						<div class="lead">
136							<p>Describes which actions are currently available.</p>
137						</div>
138					</div>
139				</section>
140				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
141					<a name="category" class="tsd-anchor"></a>
142					<h3>category</h3>
143					<div class="tsd-signature tsd-kind-icon">category<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
144					<aside class="tsd-sources">
145						<ul>
146							<li>Defined in livesplit_core.ts:626</li>
147						</ul>
148					</aside>
149					<div class="tsd-comment tsd-typography">
150						<div class="lead">
151							<p>The name of the category the Run is for.</p>
152						</div>
153					</div>
154				</section>
155				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
156					<a name="comparison_names" class="tsd-anchor"></a>
157					<h3>comparison_<wbr>names</h3>
158					<div class="tsd-signature tsd-kind-icon">comparison_<wbr>names<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
159					<aside class="tsd-sources">
160						<ul>
161							<li>Defined in livesplit_core.ts:645</li>
162						</ul>
163					</aside>
164					<div class="tsd-comment tsd-typography">
165						<div class="lead">
166							<p>The names of all the custom comparisons that exist for this Run.</p>
167						</div>
168					</div>
169				</section>
170				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
171					<a name="game" class="tsd-anchor"></a>
172					<h3>game</h3>
173					<div class="tsd-signature tsd-kind-icon">game<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
174					<aside class="tsd-sources">
175						<ul>
176							<li>Defined in livesplit_core.ts:624</li>
177						</ul>
178					</aside>
179					<div class="tsd-comment tsd-typography">
180						<div class="lead">
181							<p>The name of the game the Run is for.</p>
182						</div>
183					</div>
184				</section>
185				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
186					<a name="icon_change" class="tsd-anchor"></a>
187					<h3>icon_<wbr>change</h3>
188					<div class="tsd-signature tsd-kind-icon">icon_<wbr>change<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
189					<aside class="tsd-sources">
190						<ul>
191							<li>Defined in livesplit_core.ts:622</li>
192						</ul>
193					</aside>
194					<div class="tsd-comment tsd-typography">
195						<div class="lead">
196							<p>The game&#39;s icon encoded as a Data URL. This value is only specified
197								whenever the icon changes. The String itself may be empty. This
198							indicates that there is no icon.</p>
199						</div>
200					</div>
201				</section>
202				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
203					<a name="metadata" class="tsd-anchor"></a>
204					<h3>metadata</h3>
205					<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <a href="runmetadatajson.html" class="tsd-signature-type">RunMetadataJson</a></div>
206					<aside class="tsd-sources">
207						<ul>
208							<li>Defined in livesplit_core.ts:652</li>
209						</ul>
210					</aside>
211					<div class="tsd-comment tsd-typography">
212						<div class="lead">
213							<p>Additional metadata of this Run, like the platform and region of the
214							game.</p>
215						</div>
216					</div>
217				</section>
218				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
219					<a name="offset" class="tsd-anchor"></a>
220					<h3>offset</h3>
221					<div class="tsd-signature tsd-kind-icon">offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
222					<aside class="tsd-sources">
223						<ul>
224							<li>Defined in livesplit_core.ts:631</li>
225						</ul>
226					</aside>
227					<div class="tsd-comment tsd-typography">
228						<div class="lead">
229							<p>The timer offset specifies the time that the timer starts at when starting a
230							new attempt.</p>
231						</div>
232					</div>
233				</section>
234				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
235					<a name="segments" class="tsd-anchor"></a>
236					<h3>segments</h3>
237					<div class="tsd-signature tsd-kind-icon">segments<span class="tsd-signature-symbol">:</span> <a href="runeditorrowjson.html" class="tsd-signature-type">RunEditorRowJson</a><span class="tsd-signature-symbol">[]</span></div>
238					<aside class="tsd-sources">
239						<ul>
240							<li>Defined in livesplit_core.ts:643</li>
241						</ul>
242					</aside>
243					<div class="tsd-comment tsd-typography">
244						<div class="lead">
245							<p>The state of all the segments.</p>
246						</div>
247					</div>
248				</section>
249				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
250					<a name="timing_method" class="tsd-anchor"></a>
251					<h3>timing_<wbr>method</h3>
252					<div class="tsd-signature tsd-kind-icon">timing_<wbr>method<span class="tsd-signature-symbol">:</span> <a href="../globals.html#timingmethodjson" class="tsd-signature-type">TimingMethodJson</a></div>
253					<aside class="tsd-sources">
254						<ul>
255							<li>Defined in livesplit_core.ts:641</li>
256						</ul>
257					</aside>
258					<div class="tsd-comment tsd-typography">
259						<div class="lead">
260							<p>The timing method that is currently selected to be visualized and
261							edited.</p>
262						</div>
263					</div>
264				</section>
265			</section>
266		</div>
267		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
268			<nav class="tsd-navigation primary">
269				<ul>
270					<li class="globals  ">
271						<a href="../globals.html"><em>Globals</em></a>
272					</li>
273				</ul>
274			</nav>
275			<nav class="tsd-navigation secondary menu-sticky">
276				<ul class="before-current">
277				</ul>
278				<ul class="current">
279					<li class="current tsd-kind-interface">
280						<a href="runeditorstatejson.html" class="tsd-kind-icon">Run<wbr>Editor<wbr>State<wbr>Json</a>
281						<ul>
282							<li class=" tsd-kind-property tsd-parent-kind-interface">
283								<a href="runeditorstatejson.html#attempts" class="tsd-kind-icon">attempts</a>
284							</li>
285							<li class=" tsd-kind-property tsd-parent-kind-interface">
286								<a href="runeditorstatejson.html#buttons" class="tsd-kind-icon">buttons</a>
287							</li>
288							<li class=" tsd-kind-property tsd-parent-kind-interface">
289								<a href="runeditorstatejson.html#category" class="tsd-kind-icon">category</a>
290							</li>
291							<li class=" tsd-kind-property tsd-parent-kind-interface">
292								<a href="runeditorstatejson.html#comparison_names" class="tsd-kind-icon">comparison_<wbr>names</a>
293							</li>
294							<li class=" tsd-kind-property tsd-parent-kind-interface">
295								<a href="runeditorstatejson.html#game" class="tsd-kind-icon">game</a>
296							</li>
297							<li class=" tsd-kind-property tsd-parent-kind-interface">
298								<a href="runeditorstatejson.html#icon_change" class="tsd-kind-icon">icon_<wbr>change</a>
299							</li>
300							<li class=" tsd-kind-property tsd-parent-kind-interface">
301								<a href="runeditorstatejson.html#metadata" class="tsd-kind-icon">metadata</a>
302							</li>
303							<li class=" tsd-kind-property tsd-parent-kind-interface">
304								<a href="runeditorstatejson.html#offset" class="tsd-kind-icon">offset</a>
305							</li>
306							<li class=" tsd-kind-property tsd-parent-kind-interface">
307								<a href="runeditorstatejson.html#segments" class="tsd-kind-icon">segments</a>
308							</li>
309							<li class=" tsd-kind-property tsd-parent-kind-interface">
310								<a href="runeditorstatejson.html#timing_method" class="tsd-kind-icon">timing_<wbr>method</a>
311							</li>
312						</ul>
313					</li>
314				</ul>
315				<ul class="after-current">
316				</ul>
317			</nav>
318		</div>
319	</div>
320</div>
321<footer class="with-border-bottom">
322	<div class="container">
323		<h2>Legend</h2>
324		<div class="tsd-legend-group">
325			<ul class="tsd-legend">
326				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
327				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
328				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
329				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
330				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
331				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
332				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
333			</ul>
334			<ul class="tsd-legend">
335				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
336				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
337				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
338				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
339			</ul>
340			<ul class="tsd-legend">
341				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
342				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
343				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
344				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
345				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
346				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
347			</ul>
348			<ul class="tsd-legend">
349				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
350				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
351				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
352				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
353				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
354				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
355				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
356			</ul>
357			<ul class="tsd-legend">
358				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
359				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
360				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
361				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
362			</ul>
363			<ul class="tsd-legend">
364				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
365				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
366				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
367			</ul>
368			<ul class="tsd-legend">
369				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
370				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
371				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
372			</ul>
373			<ul class="tsd-legend">
374				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
375				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
376			</ul>
377		</div>
378	</div>
379</footer>
380<div class="container tsd-generator">
381	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
382</div>
383<div class="overlay"></div>
384<script src="../assets/js/main.js"></script>
385<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
386</body>
387</html>