e02df2e481e13e0de10a924147ff1dd884d1cf3a
[enjoyable.git] / Enjoyable Help / pgs / mouse.html
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml">
5 <head>
6 <title>Mouse Events</title>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
8 <meta name="robots" content="anchors" />
9 <link href="../sty/default.css"
10 rel="stylesheet"
11 type="text/css"
12 media="all"/>
13 </head>
14
15 <body>
16 <a name="mouse"></a>
17
18 <div id="navbox">
19 <div id="navleftbox">
20 <a class="navlink_left"
21 href="help:anchor='home' bookID='Enjoyable Help'">
22 Home
23 </a>
24 </div>
25 </div>
26
27 <div id="headerbox">
28 <div id="iconbox">
29 <img id="iconimg"
30 src="../gfx/Icon.png"
31 alt="Icon"
32 height="32" width="32"/>
33 </div>
34 <h1>Mouse Events</h1>
35 </div>
36
37 <p>
38 You can use Enjoyable to map input to mouse buttons, moving, and
39 scrolling.
40 </p>
41
42 <h3>Movement</h3>
43 <p>
44 Select the direction you'd like the input to move the
45 mouse. Adjust the movement speed using the slider underneath. If
46 you are mapping an analog input then this is the maximum speed;
47 for a button it's a constant speed.
48 </p>
49 <p>
50 The speed is set independently for each input. You can have
51 faster horizontal movement than vertical movement, or map one
52 set of inputs to a fast speed and another set to a slow
53 speed.
54 </p>
55
56 <h3>Buttons</h3>
57 <p>
58 Select the mouse button you'd like the input to simulate.
59 </p>
60
61 <h3><a name="scrolling"></a>Scrolling</h3>
62 <p>
63 Simulated scrolling can be continuous like the scrolling
64 gestures on a trackpad, or discrete like a mouse wheel that
65 clicks as you spin it.
66 </p>
67 <p>
68 To use <em>continuous scrolling</em> choose ↑ or ↓. Use the
69 slider underneath them to adjust the scrolling speed. If you are
70 mapping an analog input then this is the maximum speed; for a
71 button it's a constant speed.
72 <p>
73 To use <em>discrete scrolling</em> choose ⤒ or ⤓. The input
74 will trigger scrolling up or down by exactly one line and stop,
75 regardless of how long you hold the button down or how far
76 you move an analog input.
77 </p>
78 <p>
79 The arrows indicate the direction you would spin a mouse wheel
80 or move your fingers. Depending on settings this may mean you
81 need to choose a down arrow to scroll up and vice versa. You can
82 also change this globally in <b>> System Preferences… >
83 Mouse</b> and <b>> System Preferences… > Trackpad</b>.
84 </p>
85
86 <h3><a name="mouseissues"></a>Known Issues</h3>
87 <p>
88 Mouse events are more fragile than keyboard ones. While Enjoyble
89 will work fine for most games, regular OS X (Cocoa) applications
90 require specially formatted mouse events. Features such as
91 click-and-drag or double-clicking will not work correctly, so
92 many applications will behave incorrectly if driven by an
93 Enjoyable simulated mouse.
94 </p>
95 <p>
96 If you find a non-Cocoa application that has problems with
97 Enjoyable's mouse
98 support <a href="https://github.com/joewreschnig/enjoyable/issues">please
99 file a ticket in the issue tracker</a>.
100 </p>
101
102 </body>
103 </html>