Skip to main content

IsMousePressed

This function was added in DSL 5

Description​

Check if a mouse button is currently pressed.

Mouse buttons are in the range of [0,3] for a total of 4 buttons.

  • 0: Left mouse button
  • 1: Right mouse button
  • 2: Middle mouse button (scroll wheel)
  • 3: Extra mouse button (if available)
function IsMousePressed(button) --[[ ... ]] end

Parameters​

  • button: 0|1|2|3 - The mouse button to check.

Return Values​

  • pressed: boolean - true if the specified mouse button is currently pressed, otherwise false.

Example​

if IsMousePressed(0) then
  print('Left mouse button is currently pressed.')
end

See Also​