.. _func_input_waitmouse:

=========
WaitMouse
=========

WaitMouse - 

Description
===========

.. code-block:: blitzmax

    WaitMouse()

Wait for mouse button click

#WaitMouse suspends program execution until a mouse button is clicked.

#WaitMouse returns 1 if the left mouse button was clicked, 2 if the right mouse button was
clicked or 3 if the middle mouse button was clicked.

Parameters
==========

Return Values
=============

The clicked button

Examples
========

See Also
========