fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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