Plugins/Mouse

From EventGhost
Jump to: navigation, search
Plugin Information
Name Mouse
Authors Bitmonster
Current Version1 1.0.0
Official Website N/A
Forum Page N/A
Source Code [1]
Type Core
Source Bundled
Minimum EventGhost Version N/A

1 This is the current version as of this page's last update. Newer versions may be available.

This wiki page may be out of date. Always consult the above website and forum links for possibly updated information.

This plugin provides actions for moving the mouse pointer, and simulating mouse clicks with the left or right button.

The original intent of this plugin was to allow for mapping of mouse events to buttons on a remote control. It can also be used for some automation of repeated tasks.

Configuration

This plugin has no configuration options.

Events

Events are generated for some (but not all) mouse button clicks made by the user. No event is generated for the left or right mouse button.

Event Payload? Enduring? Description
Event.pngMouse.MiddleButton N Y Middle click (ie, pressing on the wheel button)
Event.pngMouse.XButton1 N Y Thumb button 1 (typically navigates back to the previous web page)
Event.pngMouse.XButton2 N Y Thumb button 2 (typically navigates forward to the next web page)

Actions

Left Mouse Click

Simulates a single press and release of the left mouse button.

Left Mouse Double-Click

Simulates two quick presses and releases of the left mouse button.

Left Mouse Toggle

Allows you to set the state of the left mouse button:

  • "Down" simulates pressing and holding the button;
  • "Up" simulates releasing the button from a prior "Down" action; and
  • "Toggle" switches between the two.

Right Mouse Click

Simulates a single press and release of the right mouse button.

Right Mouse Double-Click

Simulates two quick presses and releases of the right mouse button.

Middle Mouse Click

Simulates a single press and release of the middle mouse button.

Move Absolute

Moves the mouse pointer to the coordinates on the screen that you specify, regardless of its former location. You can choose to move the mouse to the center of the screen, or to move it to an absolute X and/or Y coordinate. You may also specify to which monitor of a multi-monitor setup you wish to move the pointer.

TODO: explain what "alternate method" is and when/why you'd want to use it

Move Relative

Moves the mouse pointer to a new position that's offset from its current location by the X and/or Y coordinates you specify. Negative coordinates move the pointer toward the left or top of the screen, and positive coordinates move it toward the right or bottom of the screen.

TODO: explain what "alternate method" is and when/why you'd want to use it

Start Movement

Setting Default {·} Description
Start moving cursor in direction 0.00 N Angle of the direction in which to move the pointer. 0° is straight up; 90° is to the right.
Initial mouse speed 60 N Speed at which the mouse pointer moves when the action starts.
Maximum mouse speed 7000 N Maximum speed at which the mouse pointer will move.
Acceleration factor 3 N Rate at which the movement of the pointer will speed up.
Use alternate method False N TODO

This action causes the mouse pointer to start moving in the direction you specify. The mouse continues its motion for as long as the event which triggered it endures. (Naturally, in order to be of use, this action must be triggered by an Enduring Event.)

A common use for this action is to allow for presses of directional keys on a remote control to move the mouse pointer.


Turn Mouse Wheel

Simulates the rotation of the mouse wheel, typically used for scrolling through text. You specify the number of "clicks" upward or downward to spin the wheel (this is not the same as Action.pngMiddle Mouse Click). Configuring this action with a positive number simulates rolling the mouse wheel upward, while specifying a negative number simulates rolling the mouse wheel down.

The specific meaning of one "click"-roll of the mouse wheel varies between programs, but is usually influenced by your Windows global settings. You can see or change your current settings by looking for the Mouse section of your Control Panel.

Tips

  • If you create a macro with a series of mouse movement and button press actions, it is strongly suggested that you put a Action.pngWait action between each step, even with just a small value such as 0.1 seconds. This is to allow Windows time to recognize the new position of the mouse before it processes the mouse click action.

See Also