fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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