fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
20.0 KiB419 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>TextComponentRefMut | 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="textcomponentrefmut.html">TextComponentRefMut</a>
60				</li>
61			</ul>
62			<h1>Class TextComponentRefMut</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 Text Component simply visualizes any given text. This can either be a
73							single centered text, or split up into a left and right text, which is
74						suitable for a situation where you have a label and a value.</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="textcomponentref.html" class="tsd-signature-type">TextComponentRef</a>
83						<ul class="tsd-hierarchy">
84							<li>
85								<span class="target">TextComponentRefMut</span>
86								<ul class="tsd-hierarchy">
87									<li>
88										<a href="textcomponent.html" class="tsd-signature-type">TextComponent</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="textcomponentrefmut.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="textcomponentrefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
110							</ul>
111						</section>
112						<section class="tsd-index-section ">
113							<h3>Methods</h3>
114							<ul class="tsd-index-list">
115								<li class="tsd-kind-method tsd-parent-kind-class"><a href="textcomponentrefmut.html#setcenter" class="tsd-kind-icon">set<wbr>Center</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class"><a href="textcomponentrefmut.html#setleft" class="tsd-kind-icon">set<wbr>Left</a></li>
117								<li class="tsd-kind-method tsd-parent-kind-class"><a href="textcomponentrefmut.html#setright" class="tsd-kind-icon">set<wbr>Right</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentrefmut.html#state" class="tsd-kind-icon">state</a></li>
119								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentrefmut.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a></li>
120							</ul>
121						</section>
122					</div>
123				</section>
124			</section>
125			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
126				<h2>Constructors</h2>
127				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
128					<a name="constructor" class="tsd-anchor"></a>
129					<h3>constructor</h3>
130					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
131						<li class="tsd-signature tsd-kind-icon">new <wbr>Text<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="textcomponentrefmut.html" class="tsd-signature-type">TextComponentRefMut</a></li>
132					</ul>
133					<ul class="tsd-descriptions">
134						<li class="tsd-description">
135							<aside class="tsd-sources">
136								<p>Inherited from <a href="textcomponentref.html">TextComponentRef</a>.<a href="textcomponentref.html#constructor">constructor</a></p>
137								<ul>
138									<li>Defined in livesplit_core.ts:6381</li>
139								</ul>
140							</aside>
141							<div class="tsd-comment tsd-typography">
142								<div class="lead">
143									<p>This constructor is an implementation detail. Do not use this.</p>
144								</div>
145							</div>
146							<h4 class="tsd-parameters-title">Parameters</h4>
147							<ul class="tsd-parameters">
148								<li>
149									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
150								</li>
151							</ul>
152							<h4 class="tsd-returns-title">Returns <a href="textcomponentrefmut.html" class="tsd-signature-type">TextComponentRefMut</a></h4>
153						</li>
154					</ul>
155				</section>
156			</section>
157			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
158				<h2>Properties</h2>
159				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
160					<a name="ptr" class="tsd-anchor"></a>
161					<h3>ptr</h3>
162					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
163					<aside class="tsd-sources">
164						<p>Inherited from <a href="textcomponentref.html">TextComponentRef</a>.<a href="textcomponentref.html#ptr">ptr</a></p>
165						<ul>
166							<li>Defined in livesplit_core.ts:6361</li>
167						</ul>
168					</aside>
169				</section>
170			</section>
171			<section class="tsd-panel-group tsd-member-group ">
172				<h2>Methods</h2>
173				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
174					<a name="setcenter" class="tsd-anchor"></a>
175					<h3>set<wbr>Center</h3>
176					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
177						<li class="tsd-signature tsd-kind-icon">set<wbr>Center<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
178					</ul>
179					<ul class="tsd-descriptions">
180						<li class="tsd-description">
181							<aside class="tsd-sources">
182								<ul>
183									<li>Defined in livesplit_core.ts:6400</li>
184								</ul>
185							</aside>
186							<div class="tsd-comment tsd-typography">
187								<div class="lead">
188									<p>Sets the centered text. If the current mode is split, it is switched to
189									centered mode.</p>
190								</div>
191							</div>
192							<h4 class="tsd-parameters-title">Parameters</h4>
193							<ul class="tsd-parameters">
194								<li>
195									<h5>text: <span class="tsd-signature-type">string</span></h5>
196								</li>
197							</ul>
198							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
199						</li>
200					</ul>
201				</section>
202				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
203					<a name="setleft" class="tsd-anchor"></a>
204					<h3>set<wbr>Left</h3>
205					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
206						<li class="tsd-signature tsd-kind-icon">set<wbr>Left<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
207					</ul>
208					<ul class="tsd-descriptions">
209						<li class="tsd-description">
210							<aside class="tsd-sources">
211								<ul>
212									<li>Defined in livesplit_core.ts:6410</li>
213								</ul>
214							</aside>
215							<div class="tsd-comment tsd-typography">
216								<div class="lead">
217									<p>Sets the left text. If the current mode is centered, it is switched to
218									split mode, with the right text being empty.</p>
219								</div>
220							</div>
221							<h4 class="tsd-parameters-title">Parameters</h4>
222							<ul class="tsd-parameters">
223								<li>
224									<h5>text: <span class="tsd-signature-type">string</span></h5>
225								</li>
226							</ul>
227							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
228						</li>
229					</ul>
230				</section>
231				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
232					<a name="setright" class="tsd-anchor"></a>
233					<h3>set<wbr>Right</h3>
234					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
235						<li class="tsd-signature tsd-kind-icon">set<wbr>Right<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
236					</ul>
237					<ul class="tsd-descriptions">
238						<li class="tsd-description">
239							<aside class="tsd-sources">
240								<ul>
241									<li>Defined in livesplit_core.ts:6420</li>
242								</ul>
243							</aside>
244							<div class="tsd-comment tsd-typography">
245								<div class="lead">
246									<p>Sets the right text. If the current mode is centered, it is switched to
247									split mode, with the left text being empty.</p>
248								</div>
249							</div>
250							<h4 class="tsd-parameters-title">Parameters</h4>
251							<ul class="tsd-parameters">
252								<li>
253									<h5>text: <span class="tsd-signature-type">string</span></h5>
254								</li>
255							</ul>
256							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
257						</li>
258					</ul>
259				</section>
260				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
261					<a name="state" class="tsd-anchor"></a>
262					<h3>state</h3>
263					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
264						<li class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="textcomponentstate.html" class="tsd-signature-type">TextComponentState</a></li>
265					</ul>
266					<ul class="tsd-descriptions">
267						<li class="tsd-description">
268							<aside class="tsd-sources">
269								<p>Inherited from <a href="textcomponentref.html">TextComponentRef</a>.<a href="textcomponentref.html#state">state</a></p>
270								<ul>
271									<li>Defined in livesplit_core.ts:6375</li>
272								</ul>
273							</aside>
274							<div class="tsd-comment tsd-typography">
275								<div class="lead">
276									<p>Calculates the component&#39;s state.</p>
277								</div>
278							</div>
279							<h4 class="tsd-returns-title">Returns <a href="textcomponentstate.html" class="tsd-signature-type">TextComponentState</a></h4>
280						</li>
281					</ul>
282				</section>
283				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
284					<a name="stateasjson" class="tsd-anchor"></a>
285					<h3>state<wbr>AsJson</h3>
286					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
287						<li class="tsd-signature tsd-kind-icon">state<wbr>AsJson<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
288					</ul>
289					<ul class="tsd-descriptions">
290						<li class="tsd-description">
291							<aside class="tsd-sources">
292								<p>Inherited from <a href="textcomponentref.html">TextComponentRef</a>.<a href="textcomponentref.html#stateasjson">stateAsJson</a></p>
293								<ul>
294									<li>Defined in livesplit_core.ts:6365</li>
295								</ul>
296							</aside>
297							<div class="tsd-comment tsd-typography">
298								<div class="lead">
299									<p>Encodes the component&#39;s state information as JSON.</p>
300								</div>
301							</div>
302							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
303						</li>
304					</ul>
305				</section>
306			</section>
307		</div>
308		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
309			<nav class="tsd-navigation primary">
310				<ul>
311					<li class="globals  ">
312						<a href="../globals.html"><em>Globals</em></a>
313					</li>
314				</ul>
315			</nav>
316			<nav class="tsd-navigation secondary menu-sticky">
317				<ul class="before-current">
318				</ul>
319				<ul class="current">
320					<li class="current tsd-kind-class">
321						<a href="textcomponentrefmut.html" class="tsd-kind-icon">Text<wbr>Component<wbr>Ref<wbr>Mut</a>
322						<ul>
323							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
324								<a href="textcomponentrefmut.html#constructor" class="tsd-kind-icon">constructor</a>
325							</li>
326							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
327								<a href="textcomponentrefmut.html#ptr" class="tsd-kind-icon">ptr</a>
328							</li>
329							<li class=" tsd-kind-method tsd-parent-kind-class">
330								<a href="textcomponentrefmut.html#setcenter" class="tsd-kind-icon">set<wbr>Center</a>
331							</li>
332							<li class=" tsd-kind-method tsd-parent-kind-class">
333								<a href="textcomponentrefmut.html#setleft" class="tsd-kind-icon">set<wbr>Left</a>
334							</li>
335							<li class=" tsd-kind-method tsd-parent-kind-class">
336								<a href="textcomponentrefmut.html#setright" class="tsd-kind-icon">set<wbr>Right</a>
337							</li>
338							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
339								<a href="textcomponentrefmut.html#state" class="tsd-kind-icon">state</a>
340							</li>
341							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
342								<a href="textcomponentrefmut.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a>
343							</li>
344						</ul>
345					</li>
346				</ul>
347				<ul class="after-current">
348				</ul>
349			</nav>
350		</div>
351	</div>
352</div>
353<footer class="with-border-bottom">
354	<div class="container">
355		<h2>Legend</h2>
356		<div class="tsd-legend-group">
357			<ul class="tsd-legend">
358				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
359				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
360				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
361				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
362				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
363				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
364				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
365			</ul>
366			<ul class="tsd-legend">
367				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
368				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
369				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
370				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
371			</ul>
372			<ul class="tsd-legend">
373				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
374				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
375				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
376				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
377				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
378				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
379			</ul>
380			<ul class="tsd-legend">
381				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
382				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
383				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
384				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
385				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
386				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
387				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
388			</ul>
389			<ul class="tsd-legend">
390				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
391				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
392				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
393				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
394			</ul>
395			<ul class="tsd-legend">
396				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
397				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
398				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
399			</ul>
400			<ul class="tsd-legend">
401				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
402				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
403				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
404			</ul>
405			<ul class="tsd-legend">
406				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
407				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
408			</ul>
409		</div>
410	</div>
411</footer>
412<div class="container tsd-generator">
413	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
414</div>
415<div class="overlay"></div>
416<script src="../assets/js/main.js"></script>
417<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
418</body>
419</html>