fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
13.9 KiB291 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>BlankSpaceComponentStateRefMut | 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="blankspacecomponentstaterefmut.html">BlankSpaceComponentStateRefMut</a>
60				</li>
61			</ul>
62			<h1>Class BlankSpaceComponentStateRefMut</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="blankspacecomponentstateref.html" class="tsd-signature-type">BlankSpaceComponentStateRef</a>
81						<ul class="tsd-hierarchy">
82							<li>
83								<span class="target">BlankSpaceComponentStateRefMut</span>
84								<ul class="tsd-hierarchy">
85									<li>
86										<a href="blankspacecomponentstate.html" class="tsd-signature-type">BlankSpaceComponentState</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="blankspacecomponentstaterefmut.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="blankspacecomponentstaterefmut.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="blankspacecomponentstaterefmut.html#height" class="tsd-kind-icon">height</a></li>
114							</ul>
115						</section>
116					</div>
117				</section>
118			</section>
119			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
120				<h2>Constructors</h2>
121				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
122					<a name="constructor" class="tsd-anchor"></a>
123					<h3>constructor</h3>
124					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
125						<li class="tsd-signature tsd-kind-icon">new <wbr>Blank<wbr>Space<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="blankspacecomponentstaterefmut.html" class="tsd-signature-type">BlankSpaceComponentStateRefMut</a></li>
126					</ul>
127					<ul class="tsd-descriptions">
128						<li class="tsd-description">
129							<aside class="tsd-sources">
130								<p>Inherited from <a href="blankspacecomponentstateref.html">BlankSpaceComponentStateRef</a>.<a href="blankspacecomponentstateref.html#constructor">constructor</a></p>
131								<ul>
132									<li>Defined in livesplit_core.ts:1552</li>
133								</ul>
134							</aside>
135							<div class="tsd-comment tsd-typography">
136								<div class="lead">
137									<p>This constructor is an implementation detail. Do not use this.</p>
138								</div>
139							</div>
140							<h4 class="tsd-parameters-title">Parameters</h4>
141							<ul class="tsd-parameters">
142								<li>
143									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
144								</li>
145							</ul>
146							<h4 class="tsd-returns-title">Returns <a href="blankspacecomponentstaterefmut.html" class="tsd-signature-type">BlankSpaceComponentStateRefMut</a></h4>
147						</li>
148					</ul>
149				</section>
150			</section>
151			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
152				<h2>Properties</h2>
153				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
154					<a name="ptr" class="tsd-anchor"></a>
155					<h3>ptr</h3>
156					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
157					<aside class="tsd-sources">
158						<p>Inherited from <a href="blankspacecomponentstateref.html">BlankSpaceComponentStateRef</a>.<a href="blankspacecomponentstateref.html#ptr">ptr</a></p>
159						<ul>
160							<li>Defined in livesplit_core.ts:1542</li>
161						</ul>
162					</aside>
163				</section>
164			</section>
165			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
166				<h2>Methods</h2>
167				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
168					<a name="height" class="tsd-anchor"></a>
169					<h3>height</h3>
170					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
171						<li class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
172					</ul>
173					<ul class="tsd-descriptions">
174						<li class="tsd-description">
175							<aside class="tsd-sources">
176								<p>Inherited from <a href="blankspacecomponentstateref.html">BlankSpaceComponentStateRef</a>.<a href="blankspacecomponentstateref.html#height">height</a></p>
177								<ul>
178									<li>Defined in livesplit_core.ts:1546</li>
179								</ul>
180							</aside>
181							<div class="tsd-comment tsd-typography">
182								<div class="lead">
183									<p>The height of the component.</p>
184								</div>
185							</div>
186							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
187						</li>
188					</ul>
189				</section>
190			</section>
191		</div>
192		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
193			<nav class="tsd-navigation primary">
194				<ul>
195					<li class="globals  ">
196						<a href="../globals.html"><em>Globals</em></a>
197					</li>
198				</ul>
199			</nav>
200			<nav class="tsd-navigation secondary menu-sticky">
201				<ul class="before-current">
202				</ul>
203				<ul class="current">
204					<li class="current tsd-kind-class">
205						<a href="blankspacecomponentstaterefmut.html" class="tsd-kind-icon">Blank<wbr>Space<wbr>Component<wbr>State<wbr>Ref<wbr>Mut</a>
206						<ul>
207							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
208								<a href="blankspacecomponentstaterefmut.html#constructor" class="tsd-kind-icon">constructor</a>
209							</li>
210							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
211								<a href="blankspacecomponentstaterefmut.html#ptr" class="tsd-kind-icon">ptr</a>
212							</li>
213							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
214								<a href="blankspacecomponentstaterefmut.html#height" class="tsd-kind-icon">height</a>
215							</li>
216						</ul>
217					</li>
218				</ul>
219				<ul class="after-current">
220				</ul>
221			</nav>
222		</div>
223	</div>
224</div>
225<footer class="with-border-bottom">
226	<div class="container">
227		<h2>Legend</h2>
228		<div class="tsd-legend-group">
229			<ul class="tsd-legend">
230				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
231				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
232				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
233				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
234				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
235				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
236				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
237			</ul>
238			<ul class="tsd-legend">
239				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
240				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
241				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
242				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
243			</ul>
244			<ul class="tsd-legend">
245				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
246				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
247				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
248				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
249				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
250				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
251			</ul>
252			<ul class="tsd-legend">
253				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
254				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
255				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
256				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
257				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
258				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
259				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
260			</ul>
261			<ul class="tsd-legend">
262				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
263				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
264				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
265				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
266			</ul>
267			<ul class="tsd-legend">
268				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
269				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
270				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
271			</ul>
272			<ul class="tsd-legend">
273				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
274				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
275				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
276			</ul>
277			<ul class="tsd-legend">
278				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
279				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
280			</ul>
281		</div>
282	</div>
283</footer>
284<div class="container tsd-generator">
285	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
286</div>
287<div class="overlay"></div>
288<script src="../assets/js/main.js"></script>
289<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
290</body>
291</html>