fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
12.7 KiB284 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>TimerReadLockRef | 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="timerreadlockref.html">TimerReadLockRef</a>
60				</li>
61			</ul>
62			<h1>Class TimerReadLockRef</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						<span class="target">TimerReadLockRef</span>
82						<ul class="tsd-hierarchy">
83							<li>
84								<a href="timerreadlockrefmut.html" class="tsd-signature-type">TimerReadLockRefMut</a>
85							</li>
86						</ul>
87					</li>
88				</ul>
89			</section>
90			<section class="tsd-panel-group tsd-index-group">
91				<h2>Index</h2>
92				<section class="tsd-panel tsd-index-panel">
93					<div class="tsd-index-content">
94						<section class="tsd-index-section ">
95							<h3>Constructors</h3>
96							<ul class="tsd-index-list">
97								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="timerreadlockref.html#constructor" class="tsd-kind-icon">constructor</a></li>
98							</ul>
99						</section>
100						<section class="tsd-index-section ">
101							<h3>Properties</h3>
102							<ul class="tsd-index-list">
103								<li class="tsd-kind-property tsd-parent-kind-class"><a href="timerreadlockref.html#ptr" class="tsd-kind-icon">ptr</a></li>
104							</ul>
105						</section>
106						<section class="tsd-index-section ">
107							<h3>Methods</h3>
108							<ul class="tsd-index-list">
109								<li class="tsd-kind-method tsd-parent-kind-class"><a href="timerreadlockref.html#timer" class="tsd-kind-icon">timer</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>Timer<wbr>Read<wbr>Lock<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="timerreadlockref.html" class="tsd-signature-type">TimerReadLockRef</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:7430</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="timerreadlockref.html" class="tsd-signature-type">TimerReadLockRef</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:7420</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="timer" class="tsd-anchor"></a>
163					<h3>timer</h3>
164					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
165						<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>
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:7424</li>
172								</ul>
173							</aside>
174							<div class="tsd-comment tsd-typography">
175								<div class="lead">
176									<p>Accesses the timer.</p>
177								</div>
178							</div>
179							<h4 class="tsd-returns-title">Returns <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h4>
180						</li>
181					</ul>
182				</section>
183			</section>
184		</div>
185		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
186			<nav class="tsd-navigation primary">
187				<ul>
188					<li class="globals  ">
189						<a href="../globals.html"><em>Globals</em></a>
190					</li>
191				</ul>
192			</nav>
193			<nav class="tsd-navigation secondary menu-sticky">
194				<ul class="before-current">
195				</ul>
196				<ul class="current">
197					<li class="current tsd-kind-class">
198						<a href="timerreadlockref.html" class="tsd-kind-icon">Timer<wbr>Read<wbr>Lock<wbr>Ref</a>
199						<ul>
200							<li class=" tsd-kind-constructor tsd-parent-kind-class">
201								<a href="timerreadlockref.html#constructor" class="tsd-kind-icon">constructor</a>
202							</li>
203							<li class=" tsd-kind-property tsd-parent-kind-class">
204								<a href="timerreadlockref.html#ptr" class="tsd-kind-icon">ptr</a>
205							</li>
206							<li class=" tsd-kind-method tsd-parent-kind-class">
207								<a href="timerreadlockref.html#timer" class="tsd-kind-icon">timer</a>
208							</li>
209						</ul>
210					</li>
211				</ul>
212				<ul class="after-current">
213				</ul>
214			</nav>
215		</div>
216	</div>
217</div>
218<footer class="with-border-bottom">
219	<div class="container">
220		<h2>Legend</h2>
221		<div class="tsd-legend-group">
222			<ul class="tsd-legend">
223				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
224				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
225				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
226				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
227				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
228				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
229				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
230			</ul>
231			<ul class="tsd-legend">
232				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
233				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
234				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
235				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
236			</ul>
237			<ul class="tsd-legend">
238				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
239				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
240				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
241				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
242				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
243				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
244			</ul>
245			<ul class="tsd-legend">
246				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
247				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
248				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
249				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
250				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
251				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
252				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
253			</ul>
254			<ul class="tsd-legend">
255				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
256				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
257				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
258				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
259			</ul>
260			<ul class="tsd-legend">
261				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
262				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
263				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
264			</ul>
265			<ul class="tsd-legend">
266				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
267				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
268				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
269			</ul>
270			<ul class="tsd-legend">
271				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
272				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
273			</ul>
274		</div>
275	</div>
276</footer>
277<div class="container tsd-generator">
278	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
279</div>
280<div class="overlay"></div>
281<script src="../assets/js/main.js"></script>
282<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
283</body>
284</html>