fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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