fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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