fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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