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