fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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