mouse

returns the state of a mouse button.

# Metadata

Platforms: desktop, server OS: mac, windows, linux Introduced: 1.0 Security:

# Syntax

mouse([buttonNumber])

# Params

- buttonNumber : The buttonNumber specifies which mouse button to check: - 1 is the mouse button on Mac OS systems and the left button on Windows and Unix systems. - 2 is the middle button on Unix systems. - 3 is the right button on Windows and Unix systems and Control-click on Mac OS systems.

# Examples

the mouse

mouse(3)

if mouse(defaultButton) is "up" then goBackToStart end if

# Description

Use the mouse function to check whether the user is pressing a mouse button.

If you don't specify a buttonNumber, the mouse function returns the state of mouse button 1.

# Tags

ui,

# See

- **constant:** left - **message:** mouseDoubleUp, mouseStillDown - **function:** mouseClick - **glossary:** mouse button, return