fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
11.9 KiB259 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>TimerPhase | 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="timerphase.html">TimerPhase</a>
60				</li>
61			</ul>
62			<h1>Enumeration TimerPhase</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>Describes which phase the timer is currently in. This tells you if there&#39;s an
73						active speedrun attempt and whether it is paused or it ended.</p>
74					</div>
75				</div>
76			</section>
77			<section class="tsd-panel-group tsd-index-group">
78				<h2>Index</h2>
79				<section class="tsd-panel tsd-index-panel">
80					<div class="tsd-index-content">
81						<section class="tsd-index-section ">
82							<h3>Enumeration members</h3>
83							<ul class="tsd-index-list">
84								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="timerphase.html#ended" class="tsd-kind-icon">Ended</a></li>
85								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="timerphase.html#notrunning" class="tsd-kind-icon">Not<wbr>Running</a></li>
86								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="timerphase.html#paused" class="tsd-kind-icon">Paused</a></li>
87								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="timerphase.html#running" class="tsd-kind-icon">Running</a></li>
88							</ul>
89						</section>
90					</div>
91				</section>
92			</section>
93			<section class="tsd-panel-group tsd-member-group ">
94				<h2>Enumeration members</h2>
95				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
96					<a name="ended" class="tsd-anchor"></a>
97					<h3>Ended</h3>
98					<div class="tsd-signature tsd-kind-icon">Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;2</span></div>
99					<aside class="tsd-sources">
100						<ul>
101							<li>Defined in livesplit_core.ts:86</li>
102						</ul>
103					</aside>
104					<div class="tsd-comment tsd-typography">
105						<div class="lead">
106							<p>There&#39;s an attempt that already ended, but didn&#39;t get reset yet.</p>
107						</div>
108					</div>
109				</section>
110				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
111					<a name="notrunning" class="tsd-anchor"></a>
112					<h3>Not<wbr>Running</h3>
113					<div class="tsd-signature tsd-kind-icon">Not<wbr>Running<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;0</span></div>
114					<aside class="tsd-sources">
115						<ul>
116							<li>Defined in livesplit_core.ts:82</li>
117						</ul>
118					</aside>
119					<div class="tsd-comment tsd-typography">
120						<div class="lead">
121							<p>There&#39;s currently no active attempt.</p>
122						</div>
123					</div>
124				</section>
125				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
126					<a name="paused" class="tsd-anchor"></a>
127					<h3>Paused</h3>
128					<div class="tsd-signature tsd-kind-icon">Paused<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;3</span></div>
129					<aside class="tsd-sources">
130						<ul>
131							<li>Defined in livesplit_core.ts:88</li>
132						</ul>
133					</aside>
134					<div class="tsd-comment tsd-typography">
135						<div class="lead">
136							<p>There&#39;s an active attempt that is currently paused.</p>
137						</div>
138					</div>
139				</section>
140				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
141					<a name="running" class="tsd-anchor"></a>
142					<h3>Running</h3>
143					<div class="tsd-signature tsd-kind-icon">Running<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;1</span></div>
144					<aside class="tsd-sources">
145						<ul>
146							<li>Defined in livesplit_core.ts:84</li>
147						</ul>
148					</aside>
149					<div class="tsd-comment tsd-typography">
150						<div class="lead">
151							<p>There&#39;s an active attempt that didn&#39;t end yet and isn&#39;t paused.</p>
152						</div>
153					</div>
154				</section>
155			</section>
156		</div>
157		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
158			<nav class="tsd-navigation primary">
159				<ul>
160					<li class="globals  ">
161						<a href="../globals.html"><em>Globals</em></a>
162					</li>
163				</ul>
164			</nav>
165			<nav class="tsd-navigation secondary menu-sticky">
166				<ul class="before-current">
167				</ul>
168				<ul class="current">
169					<li class="current tsd-kind-enum">
170						<a href="timerphase.html" class="tsd-kind-icon">Timer<wbr>Phase</a>
171						<ul>
172							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
173								<a href="timerphase.html#ended" class="tsd-kind-icon">Ended</a>
174							</li>
175							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
176								<a href="timerphase.html#notrunning" class="tsd-kind-icon">Not<wbr>Running</a>
177							</li>
178							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
179								<a href="timerphase.html#paused" class="tsd-kind-icon">Paused</a>
180							</li>
181							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
182								<a href="timerphase.html#running" class="tsd-kind-icon">Running</a>
183							</li>
184						</ul>
185					</li>
186				</ul>
187				<ul class="after-current">
188				</ul>
189			</nav>
190		</div>
191	</div>
192</div>
193<footer class="with-border-bottom">
194	<div class="container">
195		<h2>Legend</h2>
196		<div class="tsd-legend-group">
197			<ul class="tsd-legend">
198				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
199				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
200				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
201				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
202				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
203				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
204				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
205			</ul>
206			<ul class="tsd-legend">
207				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
208				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
209				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
210				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
211			</ul>
212			<ul class="tsd-legend">
213				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
214				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
215				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
216				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
217				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
218				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
219			</ul>
220			<ul class="tsd-legend">
221				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
222				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
223				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
224				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
225				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
226				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
227				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
228			</ul>
229			<ul class="tsd-legend">
230				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
231				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
232				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
233				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
234			</ul>
235			<ul class="tsd-legend">
236				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
237				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
238				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
239			</ul>
240			<ul class="tsd-legend">
241				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
242				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
243				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
244			</ul>
245			<ul class="tsd-legend">
246				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
247				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
248			</ul>
249		</div>
250	</div>
251</footer>
252<div class="container tsd-generator">
253	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
254</div>
255<div class="overlay"></div>
256<script src="../assets/js/main.js"></script>
257<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
258</body>
259</html>