fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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