macaroni

mouse

Description:
The mouse executor is used simulate mouse moves, clicks, or drags.

Parent: execute, then, else

Value (simple form): string specifying a new mouse (position) (default: null)
Value (key/value form):

• mouse: string, required, specifying the mouse action (click, press, release, move)
• element: string, optional, specifying the ui element name to use as position
• position: (x,y), optional, specifying a new mouse position to move to
• relative: (x,y), optional, specifying the position that position is relative to (default: 0,0, see additional info below)
• button: string, optional, specifying which button to click, press, or release (default: left)

# simple form
- mouse: (string)

# simple example
- mouse: click

# key/value form
- mouse: (string, required)
  element: (string, optional)
  position: ((x,y), optional)
  relative: ((x,y), optional)
  button: (string, optional)

# key/value example
- mouse: move
  position: '0,0'

EXAMPLE

# clicks the ui element specified
commands:
- triggers:
  - phrase: '[left] click {element}'
  execute:
  - mouse: click
    element: '{element}'

Additional information:

• relative positions can either be specified in (x,y) form, or can use resolvers, such as:
  • {window.position}
  • {mouse.position}

Status: ✅ IMPLEMENTED