ISKernel:mouse (Object Type)

From Lavish Software Wiki
Revision as of 00:59, 15 May 2006 by Lax (talk | contribs)
Jump to navigation Jump to search

Description

The object type for mouse control. The methods for this object type sends the emulation directly to the game bypassing all IS UI elements(e.g. console, user made UIs).

Members

  • string System: Name of the currently active system for mouse input (DirectInput, Win32I)
  • int X: Current mouse X position (horizontal)
  • int Y: Current mouse Y position (vertical)

Methods

  • LeftClick: Presses and immediately releases the left mouse button
  • RightClick: Presses and immediately releases the right mouse button
  • HoldLeft: Presses and holds the left mouse button
  • ReleaseLeft: Releases the left mouse button
  • HoldRight: Presses and holds the right mouse button
  • ReleaseRight: Releases the right mouse button
  • SetPosition[x,y]: Sets the mouse position

Returns

Position of the mouse, in the form X,Y, such as 0,0 or 263,475

Examples

Display active system for mouse input

  • echo Current mouse input: ${Mouse.System}
Output
Current mouse input: Win32I

Display mouse pointers position

  • echo Mouse Pos: ${Mouse}
Output
Mouse Pos: 378,607

Click the left mouse button

  • Mouse:LeftClick
This command clicks the left mouse button

Click the right mouse button

  • Mouse:RightClick
This command clicks the right mouse button

Click and hold the left mouse button

  • Mouse:HoldLeft
This command clicks and holds down the left mouse button

Release the left mouse button

  • Mouse:ReleaseLeft
This command releases the left mouse button

Sets the mouse position to a given X,Y

  • Mouse:SetPosition[250,500]
This command will move mouse pointer to the pixel at 250,500
Sample
do
{
   Mouse:SetPosition[275,437]
   Mouse:LeftClick
   Mouse:LeftClick
   wait 5
   Mouse:SetPosition[453,437]
   Mouse:LeftClick
   Mouse:LeftClick
   wait 5
 }
while (1)

See Also