fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
15.5 KiB330 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>TimerComponentRef | 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="timercomponentref.html">TimerComponentRef</a>
60				</li>
61			</ul>
62			<h1>Class TimerComponentRef</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 Timer Component is a component that shows the total time of the current
73							attempt as a digital clock. The color of the time shown is based on a how
74						well the current attempt is doing compared to the chosen comparison.</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						<span class="target">TimerComponentRef</span>
83						<ul class="tsd-hierarchy">
84							<li>
85								<a href="timercomponentrefmut.html" class="tsd-signature-type">TimerComponentRefMut</a>
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 ">
96							<h3>Constructors</h3>
97							<ul class="tsd-index-list">
98								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="timercomponentref.html#constructor" class="tsd-kind-icon">constructor</a></li>
99							</ul>
100						</section>
101						<section class="tsd-index-section ">
102							<h3>Properties</h3>
103							<ul class="tsd-index-list">
104								<li class="tsd-kind-property tsd-parent-kind-class"><a href="timercomponentref.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="timercomponentref.html#state" class="tsd-kind-icon">state</a></li>
111								<li class="tsd-kind-method tsd-parent-kind-class"><a href="timercomponentref.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a></li>
112							</ul>
113						</section>
114					</div>
115				</section>
116			</section>
117			<section class="tsd-panel-group tsd-member-group ">
118				<h2>Constructors</h2>
119				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
120					<a name="constructor" class="tsd-anchor"></a>
121					<h3>constructor</h3>
122					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
123						<li class="tsd-signature tsd-kind-icon">new <wbr>Timer<wbr>Component<wbr>Ref<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="timercomponentref.html" class="tsd-signature-type">TimerComponentRef</a></li>
124					</ul>
125					<ul class="tsd-descriptions">
126						<li class="tsd-description">
127							<aside class="tsd-sources">
128								<ul>
129									<li>Defined in livesplit_core.ts:7268</li>
130								</ul>
131							</aside>
132							<div class="tsd-comment tsd-typography">
133								<div class="lead">
134									<p>This constructor is an implementation detail. Do not use this.</p>
135								</div>
136							</div>
137							<h4 class="tsd-parameters-title">Parameters</h4>
138							<ul class="tsd-parameters">
139								<li>
140									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
141								</li>
142							</ul>
143							<h4 class="tsd-returns-title">Returns <a href="timercomponentref.html" class="tsd-signature-type">TimerComponentRef</a></h4>
144						</li>
145					</ul>
146				</section>
147			</section>
148			<section class="tsd-panel-group tsd-member-group ">
149				<h2>Properties</h2>
150				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
151					<a name="ptr" class="tsd-anchor"></a>
152					<h3>ptr</h3>
153					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
154					<aside class="tsd-sources">
155						<ul>
156							<li>Defined in livesplit_core.ts:7235</li>
157						</ul>
158					</aside>
159				</section>
160			</section>
161			<section class="tsd-panel-group tsd-member-group ">
162				<h2>Methods</h2>
163				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
164					<a name="state" class="tsd-anchor"></a>
165					<h3>state</h3>
166					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
167						<li class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a>, layoutSettings<span class="tsd-signature-symbol">: </span><a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="timercomponentstate.html" class="tsd-signature-type">TimerComponentState</a></li>
168					</ul>
169					<ul class="tsd-descriptions">
170						<li class="tsd-description">
171							<aside class="tsd-sources">
172								<ul>
173									<li>Defined in livesplit_core.ts:7256</li>
174								</ul>
175							</aside>
176							<div class="tsd-comment tsd-typography">
177								<div class="lead">
178									<p>Calculates the component&#39;s state based on the timer and the layout
179									settings provided.</p>
180								</div>
181							</div>
182							<h4 class="tsd-parameters-title">Parameters</h4>
183							<ul class="tsd-parameters">
184								<li>
185									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
186								</li>
187								<li>
188									<h5>layoutSettings: <a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a></h5>
189								</li>
190							</ul>
191							<h4 class="tsd-returns-title">Returns <a href="timercomponentstate.html" class="tsd-signature-type">TimerComponentState</a></h4>
192						</li>
193					</ul>
194				</section>
195				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
196					<a name="stateasjson" class="tsd-anchor"></a>
197					<h3>state<wbr>AsJson</h3>
198					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
199						<li class="tsd-signature tsd-kind-icon">state<wbr>AsJson<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a>, layoutSettings<span class="tsd-signature-symbol">: </span><a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
200					</ul>
201					<ul class="tsd-descriptions">
202						<li class="tsd-description">
203							<aside class="tsd-sources">
204								<ul>
205									<li>Defined in livesplit_core.ts:7239</li>
206								</ul>
207							</aside>
208							<div class="tsd-comment tsd-typography">
209								<div class="lead">
210									<p>Encodes the component&#39;s state information as JSON.</p>
211								</div>
212							</div>
213							<h4 class="tsd-parameters-title">Parameters</h4>
214							<ul class="tsd-parameters">
215								<li>
216									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
217								</li>
218								<li>
219									<h5>layoutSettings: <a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a></h5>
220								</li>
221							</ul>
222							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
223						</li>
224					</ul>
225				</section>
226			</section>
227		</div>
228		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
229			<nav class="tsd-navigation primary">
230				<ul>
231					<li class="globals  ">
232						<a href="../globals.html"><em>Globals</em></a>
233					</li>
234				</ul>
235			</nav>
236			<nav class="tsd-navigation secondary menu-sticky">
237				<ul class="before-current">
238				</ul>
239				<ul class="current">
240					<li class="current tsd-kind-class">
241						<a href="timercomponentref.html" class="tsd-kind-icon">Timer<wbr>Component<wbr>Ref</a>
242						<ul>
243							<li class=" tsd-kind-constructor tsd-parent-kind-class">
244								<a href="timercomponentref.html#constructor" class="tsd-kind-icon">constructor</a>
245							</li>
246							<li class=" tsd-kind-property tsd-parent-kind-class">
247								<a href="timercomponentref.html#ptr" class="tsd-kind-icon">ptr</a>
248							</li>
249							<li class=" tsd-kind-method tsd-parent-kind-class">
250								<a href="timercomponentref.html#state" class="tsd-kind-icon">state</a>
251							</li>
252							<li class=" tsd-kind-method tsd-parent-kind-class">
253								<a href="timercomponentref.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a>
254							</li>
255						</ul>
256					</li>
257				</ul>
258				<ul class="after-current">
259				</ul>
260			</nav>
261		</div>
262	</div>
263</div>
264<footer class="with-border-bottom">
265	<div class="container">
266		<h2>Legend</h2>
267		<div class="tsd-legend-group">
268			<ul class="tsd-legend">
269				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
270				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
271				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
272				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
273				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
274				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
275				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
276			</ul>
277			<ul class="tsd-legend">
278				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
279				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
280				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
281				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
282			</ul>
283			<ul class="tsd-legend">
284				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
285				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
286				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
287				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
288				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
289				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
290			</ul>
291			<ul class="tsd-legend">
292				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
293				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
294				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
295				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
296				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
297				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
298				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
299			</ul>
300			<ul class="tsd-legend">
301				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
302				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
303				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
304				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
305			</ul>
306			<ul class="tsd-legend">
307				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
308				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
309				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
310			</ul>
311			<ul class="tsd-legend">
312				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
313				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
314				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
315			</ul>
316			<ul class="tsd-legend">
317				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
318				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
319			</ul>
320		</div>
321	</div>
322</footer>
323<div class="container tsd-generator">
324	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
325</div>
326<div class="overlay"></div>
327<script src="../assets/js/main.js"></script>
328<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
329</body>
330</html>