fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
15.5 KiB324 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>HotkeySystemRefMut | 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="hotkeysystemrefmut.html">HotkeySystemRefMut</a>
60				</li>
61			</ul>
62			<h1>Class HotkeySystemRefMut</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>With a Hotkey System the runner can use hotkeys on their keyboard to control
73							the Timer. The hotkeys are global, so the application doesn&#39;t need to be in
74							focus. The behavior of the hotkeys depends on the platform and is stubbed
75							out on platforms that don&#39;t support hotkeys. You can turn off a Hotkey
76						System temporarily. By default the Hotkey System is activated.</p>
77					</div>
78				</div>
79			</section>
80			<section class="tsd-panel tsd-hierarchy">
81				<h3>Hierarchy</h3>
82				<ul class="tsd-hierarchy">
83					<li>
84						<a href="hotkeysystemref.html" class="tsd-signature-type">HotkeySystemRef</a>
85						<ul class="tsd-hierarchy">
86							<li>
87								<span class="target">HotkeySystemRefMut</span>
88								<ul class="tsd-hierarchy">
89									<li>
90										<a href="hotkeysystem.html" class="tsd-signature-type">HotkeySystem</a>
91									</li>
92								</ul>
93							</li>
94						</ul>
95					</li>
96				</ul>
97			</section>
98			<section class="tsd-panel-group tsd-index-group">
99				<h2>Index</h2>
100				<section class="tsd-panel tsd-index-panel">
101					<div class="tsd-index-content">
102						<section class="tsd-index-section tsd-is-inherited">
103							<h3>Constructors</h3>
104							<ul class="tsd-index-list">
105								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="hotkeysystemrefmut.html#constructor" class="tsd-kind-icon">constructor</a></li>
106							</ul>
107						</section>
108						<section class="tsd-index-section tsd-is-inherited">
109							<h3>Properties</h3>
110							<ul class="tsd-index-list">
111								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="hotkeysystemrefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
112							</ul>
113						</section>
114						<section class="tsd-index-section tsd-is-inherited">
115							<h3>Methods</h3>
116							<ul class="tsd-index-list">
117								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="hotkeysystemrefmut.html#activate" class="tsd-kind-icon">activate</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="hotkeysystemrefmut.html#deactivate" class="tsd-kind-icon">deactivate</a></li>
119							</ul>
120						</section>
121					</div>
122				</section>
123			</section>
124			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
125				<h2>Constructors</h2>
126				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
127					<a name="constructor" class="tsd-anchor"></a>
128					<h3>constructor</h3>
129					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
130						<li class="tsd-signature tsd-kind-icon">new <wbr>Hotkey<wbr>System<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="hotkeysystemrefmut.html" class="tsd-signature-type">HotkeySystemRefMut</a></li>
131					</ul>
132					<ul class="tsd-descriptions">
133						<li class="tsd-description">
134							<aside class="tsd-sources">
135								<p>Inherited from <a href="hotkeysystemref.html">HotkeySystemRef</a>.<a href="hotkeysystemref.html#constructor">constructor</a></p>
136								<ul>
137									<li>Defined in livesplit_core.ts:2919</li>
138								</ul>
139							</aside>
140							<div class="tsd-comment tsd-typography">
141								<div class="lead">
142									<p>This constructor is an implementation detail. Do not use this.</p>
143								</div>
144							</div>
145							<h4 class="tsd-parameters-title">Parameters</h4>
146							<ul class="tsd-parameters">
147								<li>
148									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
149								</li>
150							</ul>
151							<h4 class="tsd-returns-title">Returns <a href="hotkeysystemrefmut.html" class="tsd-signature-type">HotkeySystemRefMut</a></h4>
152						</li>
153					</ul>
154				</section>
155			</section>
156			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
157				<h2>Properties</h2>
158				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
159					<a name="ptr" class="tsd-anchor"></a>
160					<h3>ptr</h3>
161					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
162					<aside class="tsd-sources">
163						<p>Inherited from <a href="hotkeysystemref.html">HotkeySystemRef</a>.<a href="hotkeysystemref.html#ptr">ptr</a></p>
164						<ul>
165							<li>Defined in livesplit_core.ts:2899</li>
166						</ul>
167					</aside>
168				</section>
169			</section>
170			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
171				<h2>Methods</h2>
172				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
173					<a name="activate" class="tsd-anchor"></a>
174					<h3>activate</h3>
175					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
176						<li class="tsd-signature tsd-kind-icon">activate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
177					</ul>
178					<ul class="tsd-descriptions">
179						<li class="tsd-description">
180							<aside class="tsd-sources">
181								<p>Inherited from <a href="hotkeysystemref.html">HotkeySystemRef</a>.<a href="hotkeysystemref.html#activate">activate</a></p>
182								<ul>
183									<li>Defined in livesplit_core.ts:2914</li>
184								</ul>
185							</aside>
186							<div class="tsd-comment tsd-typography">
187								<div class="lead">
188									<p>Activates a previously deactivated Hotkey System. If it&#39;s already
189									active, nothing happens.</p>
190								</div>
191							</div>
192							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
193						</li>
194					</ul>
195				</section>
196				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
197					<a name="deactivate" class="tsd-anchor"></a>
198					<h3>deactivate</h3>
199					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
200						<li class="tsd-signature tsd-kind-icon">deactivate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
201					</ul>
202					<ul class="tsd-descriptions">
203						<li class="tsd-description">
204							<aside class="tsd-sources">
205								<p>Inherited from <a href="hotkeysystemref.html">HotkeySystemRef</a>.<a href="hotkeysystemref.html#deactivate">deactivate</a></p>
206								<ul>
207									<li>Defined in livesplit_core.ts:2904</li>
208								</ul>
209							</aside>
210							<div class="tsd-comment tsd-typography">
211								<div class="lead">
212									<p>Deactivates the Hotkey System. No hotkeys will go through until it gets
213									activated again. If it&#39;s already deactivated, nothing happens.</p>
214								</div>
215							</div>
216							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
217						</li>
218					</ul>
219				</section>
220			</section>
221		</div>
222		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
223			<nav class="tsd-navigation primary">
224				<ul>
225					<li class="globals  ">
226						<a href="../globals.html"><em>Globals</em></a>
227					</li>
228				</ul>
229			</nav>
230			<nav class="tsd-navigation secondary menu-sticky">
231				<ul class="before-current">
232				</ul>
233				<ul class="current">
234					<li class="current tsd-kind-class">
235						<a href="hotkeysystemrefmut.html" class="tsd-kind-icon">Hotkey<wbr>System<wbr>Ref<wbr>Mut</a>
236						<ul>
237							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
238								<a href="hotkeysystemrefmut.html#constructor" class="tsd-kind-icon">constructor</a>
239							</li>
240							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
241								<a href="hotkeysystemrefmut.html#ptr" class="tsd-kind-icon">ptr</a>
242							</li>
243							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
244								<a href="hotkeysystemrefmut.html#activate" class="tsd-kind-icon">activate</a>
245							</li>
246							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
247								<a href="hotkeysystemrefmut.html#deactivate" class="tsd-kind-icon">deactivate</a>
248							</li>
249						</ul>
250					</li>
251				</ul>
252				<ul class="after-current">
253				</ul>
254			</nav>
255		</div>
256	</div>
257</div>
258<footer class="with-border-bottom">
259	<div class="container">
260		<h2>Legend</h2>
261		<div class="tsd-legend-group">
262			<ul class="tsd-legend">
263				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
264				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
265				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
266				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
267				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
268				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
269				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
270			</ul>
271			<ul class="tsd-legend">
272				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
273				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
274				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
275				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
276			</ul>
277			<ul class="tsd-legend">
278				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
279				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
280				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
281				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
282				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
283				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
284			</ul>
285			<ul class="tsd-legend">
286				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
287				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
288				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
289				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
290				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
291				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
292				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
293			</ul>
294			<ul class="tsd-legend">
295				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
296				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
297				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
298				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
299			</ul>
300			<ul class="tsd-legend">
301				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
302				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
303				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
304			</ul>
305			<ul class="tsd-legend">
306				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
307				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
308				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
309			</ul>
310			<ul class="tsd-legend">
311				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
312				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
313			</ul>
314		</div>
315	</div>
316</footer>
317<div class="container tsd-generator">
318	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
319</div>
320<div class="overlay"></div>
321<script src="../assets/js/main.js"></script>
322<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
323</body>
324</html>