<doc>
  <legacy_id>1848</legacy_id>
  <name>mouse</name>
  <type>function</type>
  <syntax>
    <example>mouse([<i>buttonNumber</i>])</example>
    <example>the mouse</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <constant tag="left">left Constant</constant>
    <function tag="mouseClick">mouseClick Function</function>
    <message tag="mouseStillDown">mouseStillDown Message</message>
    <message tag="mouseDoubleUp">mouseDoubleUp Message</message>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary><glossary tag="return">Returns</glossary> the state of a <glossary tag="mouse button">mouse button</glossary>.</summary>
  <examples>
    <example>the mouse</example>
    <example>mouse(3)</example>
    <example>if mouse(defaultButton) is "up" then</p><p>  goBackToStart</p><p>end if</example>
  </examples>
  <description>
    <p>Use the <b>mouse</b> function to check whether the user is pressing a mouse button.</p><p/><p><b>Parameters:</b></p><p>The <i>buttonNumber</i> specifies which mouse button to check:</p><p/><p>* 1 is the mouse button on Mac OS systems and the left button on Windows and Unix systems.</p><p>* 2 is the middle button on Unix systems.</p><p>* 3 is the right button on Windows and Unix systems and Control-click on Mac OS systems.</p><p/><p><b>Comments:</b></p><p>If you don't specify a <i>buttonNumber</i>, the <b>mouse</b> function returns the state of mouse button 1.</p>
  </description>
</doc>