<doc>
  <legacy_id>1070</legacy_id>
  <name>mouseClick</name>
  <type>function</type>
  <syntax>
    <example>the mouseClick</example>
    <example>mouseClick()</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <command tag="click">click Command</command>
    <function tag="clickLoc">clickLoc Function</function>
    <function tag="mouse">mouse Function</function>
    <message tag="mouseDown">mouseDown Message</message>
    <function tag="mouseLoc">mouseLoc Function</function>
    <message tag="mouseUp">mouseUp Message</message>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary><glossary tag="return">Returns</glossary> true if the user has clicked since the <glossary tag="event">event</glossary> that caused the current <glossary tag="handler">handler</glossary> to run (or since the last time the <b>mouseClick</b> was checked).</summary>
  <examples>
    <example>the mouseClick</example>
    <example>wait until the mouseClick</example>
  </examples>
  <description>
    <p>Use the <b>mouseClick</b> <control_st tag="function">function</control_st> to keep track of clicks, or to <glossary tag="trigger">trigger</glossary> some action within a <glossary tag="handler">handler</glossary> when the user clicks.</p><p/><p><b>Value:</b></p><p>The <b>mouseClick</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> true or false.</p><p/><p><b>Comments:</b></p><p>On systems with multi-button mice, the <b>mouseClick</b> <control_st tag="function">function</control_st> tracks <glossary tag="mouse button">mouse button</glossary> 1. Clicking <glossary tag="mouse button">mouse button</glossary> 2 or 3 does not affect the value of the <b>mouseClick</b>.</p><p/><p>Clicks generated by the <b>click</b> command do not affect the <b>mouseClick</b> <control_st tag="function">function</control_st>. Only an actual click can cause the <b>mouseClick</b> to <constant tag="return">return</constant> true.</p><p/><p>Checking the <b>mouseClick</b> <control_st tag="function">function</control_st> clears any previous clicks. If the user clicks, and then the <b>mouseClick</b> is called, it <glossary tag="return">returns</glossary> true. If the <b>mouseClick</b> is then called again (and the user hasn't clicked again meanwhile), the <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> false.</p>
  </description>
</doc>