fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
18.3 KiB375 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>TextComponentStateRefMut | 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="textcomponentstaterefmut.html">TextComponentStateRefMut</a>
60				</li>
61			</ul>
62			<h1>Class TextComponentStateRefMut</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 state object describes the information to visualize for this component.</p>
73					</div>
74				</div>
75			</section>
76			<section class="tsd-panel tsd-hierarchy">
77				<h3>Hierarchy</h3>
78				<ul class="tsd-hierarchy">
79					<li>
80						<a href="textcomponentstateref.html" class="tsd-signature-type">TextComponentStateRef</a>
81						<ul class="tsd-hierarchy">
82							<li>
83								<span class="target">TextComponentStateRefMut</span>
84								<ul class="tsd-hierarchy">
85									<li>
86										<a href="textcomponentstate.html" class="tsd-signature-type">TextComponentState</a>
87									</li>
88								</ul>
89							</li>
90						</ul>
91					</li>
92				</ul>
93			</section>
94			<section class="tsd-panel-group tsd-index-group">
95				<h2>Index</h2>
96				<section class="tsd-panel tsd-index-panel">
97					<div class="tsd-index-content">
98						<section class="tsd-index-section tsd-is-inherited">
99							<h3>Constructors</h3>
100							<ul class="tsd-index-list">
101								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentstaterefmut.html#constructor" class="tsd-kind-icon">constructor</a></li>
102							</ul>
103						</section>
104						<section class="tsd-index-section tsd-is-inherited">
105							<h3>Properties</h3>
106							<ul class="tsd-index-list">
107								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentstaterefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
108							</ul>
109						</section>
110						<section class="tsd-index-section tsd-is-inherited">
111							<h3>Methods</h3>
112							<ul class="tsd-index-list">
113								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentstaterefmut.html#center" class="tsd-kind-icon">center</a></li>
114								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentstaterefmut.html#issplit" class="tsd-kind-icon">is<wbr>Split</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentstaterefmut.html#left" class="tsd-kind-icon">left</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="textcomponentstaterefmut.html#right" class="tsd-kind-icon">right</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>Text<wbr>Component<wbr>State<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="textcomponentstaterefmut.html" class="tsd-signature-type">TextComponentStateRefMut</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="textcomponentstateref.html">TextComponentStateRef</a>.<a href="textcomponentstateref.html#constructor">constructor</a></p>
134								<ul>
135									<li>Defined in livesplit_core.ts:6526</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="textcomponentstaterefmut.html" class="tsd-signature-type">TextComponentStateRefMut</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="textcomponentstateref.html">TextComponentStateRef</a>.<a href="textcomponentstateref.html#ptr">ptr</a></p>
162						<ul>
163							<li>Defined in livesplit_core.ts:6483</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="center" class="tsd-anchor"></a>
172					<h3>center</h3>
173					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
174						<li class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
175					</ul>
176					<ul class="tsd-descriptions">
177						<li class="tsd-description">
178							<aside class="tsd-sources">
179								<p>Inherited from <a href="textcomponentstateref.html">TextComponentStateRef</a>.<a href="textcomponentstateref.html#center">center</a></p>
180								<ul>
181									<li>Defined in livesplit_core.ts:6510</li>
182								</ul>
183							</aside>
184							<div class="tsd-comment tsd-typography">
185								<div class="lead">
186									<p>Accesses the centered text. If the text isn&#39;t centered, an empty string is
187									returned instead.</p>
188								</div>
189							</div>
190							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
191						</li>
192					</ul>
193				</section>
194				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
195					<a name="issplit" class="tsd-anchor"></a>
196					<h3>is<wbr>Split</h3>
197					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
198						<li class="tsd-signature tsd-kind-icon">is<wbr>Split<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
199					</ul>
200					<ul class="tsd-descriptions">
201						<li class="tsd-description">
202							<aside class="tsd-sources">
203								<p>Inherited from <a href="textcomponentstateref.html">TextComponentStateRef</a>.<a href="textcomponentstateref.html#issplit">isSplit</a></p>
204								<ul>
205									<li>Defined in livesplit_core.ts:6520</li>
206								</ul>
207							</aside>
208							<div class="tsd-comment tsd-typography">
209								<div class="lead">
210									<p>Returns whether the text is split up into a left and right part.</p>
211								</div>
212							</div>
213							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
214						</li>
215					</ul>
216				</section>
217				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
218					<a name="left" class="tsd-anchor"></a>
219					<h3>left</h3>
220					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
221						<li class="tsd-signature tsd-kind-icon">left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
222					</ul>
223					<ul class="tsd-descriptions">
224						<li class="tsd-description">
225							<aside class="tsd-sources">
226								<p>Inherited from <a href="textcomponentstateref.html">TextComponentStateRef</a>.<a href="textcomponentstateref.html#left">left</a></p>
227								<ul>
228									<li>Defined in livesplit_core.ts:6488</li>
229								</ul>
230							</aside>
231							<div class="tsd-comment tsd-typography">
232								<div class="lead">
233									<p>Accesses the left part of the text. If the text isn&#39;t split up, an empty
234									string is returned instead.</p>
235								</div>
236							</div>
237							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
238						</li>
239					</ul>
240				</section>
241				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
242					<a name="right" class="tsd-anchor"></a>
243					<h3>right</h3>
244					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
245						<li class="tsd-signature tsd-kind-icon">right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
246					</ul>
247					<ul class="tsd-descriptions">
248						<li class="tsd-description">
249							<aside class="tsd-sources">
250								<p>Inherited from <a href="textcomponentstateref.html">TextComponentStateRef</a>.<a href="textcomponentstateref.html#right">right</a></p>
251								<ul>
252									<li>Defined in livesplit_core.ts:6499</li>
253								</ul>
254							</aside>
255							<div class="tsd-comment tsd-typography">
256								<div class="lead">
257									<p>Accesses the right part of the text. If the text isn&#39;t split up, an empty
258									string is returned instead.</p>
259								</div>
260							</div>
261							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
262						</li>
263					</ul>
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-class">
280						<a href="textcomponentstaterefmut.html" class="tsd-kind-icon">Text<wbr>Component<wbr>State<wbr>Ref<wbr>Mut</a>
281						<ul>
282							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
283								<a href="textcomponentstaterefmut.html#constructor" class="tsd-kind-icon">constructor</a>
284							</li>
285							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
286								<a href="textcomponentstaterefmut.html#ptr" class="tsd-kind-icon">ptr</a>
287							</li>
288							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
289								<a href="textcomponentstaterefmut.html#center" class="tsd-kind-icon">center</a>
290							</li>
291							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
292								<a href="textcomponentstaterefmut.html#issplit" class="tsd-kind-icon">is<wbr>Split</a>
293							</li>
294							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
295								<a href="textcomponentstaterefmut.html#left" class="tsd-kind-icon">left</a>
296							</li>
297							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
298								<a href="textcomponentstaterefmut.html#right" class="tsd-kind-icon">right</a>
299							</li>
300						</ul>
301					</li>
302				</ul>
303				<ul class="after-current">
304				</ul>
305			</nav>
306		</div>
307	</div>
308</div>
309<footer class="with-border-bottom">
310	<div class="container">
311		<h2>Legend</h2>
312		<div class="tsd-legend-group">
313			<ul class="tsd-legend">
314				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
315				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
316				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
317				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
318				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
319				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
320				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
321			</ul>
322			<ul class="tsd-legend">
323				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
324				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
325				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
326				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
327			</ul>
328			<ul class="tsd-legend">
329				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
330				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
331				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
332				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
333				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
334				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
335			</ul>
336			<ul class="tsd-legend">
337				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
338				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
339				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
340				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
341				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
342				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
343				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
344			</ul>
345			<ul class="tsd-legend">
346				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
347				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
348				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
349				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
350			</ul>
351			<ul class="tsd-legend">
352				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
353				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
354				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
355			</ul>
356			<ul class="tsd-legend">
357				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
358				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
359				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
360			</ul>
361			<ul class="tsd-legend">
362				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
363				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
364			</ul>
365		</div>
366	</div>
367</footer>
368<div class="container tsd-generator">
369	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
370</div>
371<div class="overlay"></div>
372<script src="../assets/js/main.js"></script>
373<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
374</body>
375</html>