fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
11.8 KiB257 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>AnalysisRefMut | 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="analysisrefmut.html">AnalysisRefMut</a>
60				</li>
61			</ul>
62			<h1>Class AnalysisRefMut</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 analysis module provides a variety of functions for calculating
73						information about runs.</p>
74					</div>
75				</div>
76			</section>
77			<section class="tsd-panel tsd-hierarchy">
78				<h3>Hierarchy</h3>
79				<ul class="tsd-hierarchy">
80					<li>
81						<a href="analysisref.html" class="tsd-signature-type">AnalysisRef</a>
82						<ul class="tsd-hierarchy">
83							<li>
84								<span class="target">AnalysisRefMut</span>
85								<ul class="tsd-hierarchy">
86									<li>
87										<a href="analysis.html" class="tsd-signature-type">Analysis</a>
88									</li>
89								</ul>
90							</li>
91						</ul>
92					</li>
93				</ul>
94			</section>
95			<section class="tsd-panel-group tsd-index-group">
96				<h2>Index</h2>
97				<section class="tsd-panel tsd-index-panel">
98					<div class="tsd-index-content">
99						<section class="tsd-index-section tsd-is-inherited">
100							<h3>Constructors</h3>
101							<ul class="tsd-index-list">
102								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="analysisrefmut.html#constructor" class="tsd-kind-icon">constructor</a></li>
103							</ul>
104						</section>
105						<section class="tsd-index-section tsd-is-inherited">
106							<h3>Properties</h3>
107							<ul class="tsd-index-list">
108								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="analysisrefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
109							</ul>
110						</section>
111					</div>
112				</section>
113			</section>
114			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
115				<h2>Constructors</h2>
116				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
117					<a name="constructor" class="tsd-anchor"></a>
118					<h3>constructor</h3>
119					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
120						<li class="tsd-signature tsd-kind-icon">new <wbr>Analysis<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="analysisrefmut.html" class="tsd-signature-type">AnalysisRefMut</a></li>
121					</ul>
122					<ul class="tsd-descriptions">
123						<li class="tsd-description">
124							<aside class="tsd-sources">
125								<p>Inherited from <a href="analysisref.html">AnalysisRef</a>.<a href="analysisref.html#constructor">constructor</a></p>
126								<ul>
127									<li>Defined in livesplit_core.ts:1146</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="analysisrefmut.html" class="tsd-signature-type">AnalysisRefMut</a></h4>
142						</li>
143					</ul>
144				</section>
145			</section>
146			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
147				<h2>Properties</h2>
148				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
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						<p>Inherited from <a href="analysisref.html">AnalysisRef</a>.<a href="analysisref.html#ptr">ptr</a></p>
154						<ul>
155							<li>Defined in livesplit_core.ts:1146</li>
156						</ul>
157					</aside>
158				</section>
159			</section>
160		</div>
161		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
162			<nav class="tsd-navigation primary">
163				<ul>
164					<li class="globals  ">
165						<a href="../globals.html"><em>Globals</em></a>
166					</li>
167				</ul>
168			</nav>
169			<nav class="tsd-navigation secondary menu-sticky">
170				<ul class="before-current">
171				</ul>
172				<ul class="current">
173					<li class="current tsd-kind-class">
174						<a href="analysisrefmut.html" class="tsd-kind-icon">Analysis<wbr>Ref<wbr>Mut</a>
175						<ul>
176							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
177								<a href="analysisrefmut.html#constructor" class="tsd-kind-icon">constructor</a>
178							</li>
179							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
180								<a href="analysisrefmut.html#ptr" class="tsd-kind-icon">ptr</a>
181							</li>
182						</ul>
183					</li>
184				</ul>
185				<ul class="after-current">
186				</ul>
187			</nav>
188		</div>
189	</div>
190</div>
191<footer class="with-border-bottom">
192	<div class="container">
193		<h2>Legend</h2>
194		<div class="tsd-legend-group">
195			<ul class="tsd-legend">
196				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
197				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
198				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
199				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
200				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
201				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
202				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
203			</ul>
204			<ul class="tsd-legend">
205				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
206				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
207				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
208				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
209			</ul>
210			<ul class="tsd-legend">
211				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
212				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
213				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
214				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
215				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
216				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
217			</ul>
218			<ul class="tsd-legend">
219				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
220				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
221				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
222				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
223				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
224				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
225				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
226			</ul>
227			<ul class="tsd-legend">
228				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
229				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
230				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
231				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
232			</ul>
233			<ul class="tsd-legend">
234				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
235				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
236				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
237			</ul>
238			<ul class="tsd-legend">
239				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
240				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
241				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
242			</ul>
243			<ul class="tsd-legend">
244				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
245				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
246			</ul>
247		</div>
248	</div>
249</footer>
250<div class="container tsd-generator">
251	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
252</div>
253<div class="overlay"></div>
254<script src="../assets/js/main.js"></script>
255<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
256</body>
257</html>