<doc>
  <legacy_id>2242</legacy_id>
  <name>optionKey</name>
  <type>function</type>
  <syntax>
    <example>the optionKey</example>
    <example>optionKey()</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <constant tag="left">left Constant</constant>
    <function tag="keysDown">keysDown Function</function>
    <message tag="optionKeyDown">optionKeyDown 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 the <glossary tag="Option key">Option key</glossary>.</summary>
  <examples>
    <example>wait until the optionKey is down</example>
    <example>put the optionKey into item 2 of keyState</example>
  </examples>
  <description>
    <p>Use the <b>optionKey</b> <control_st tag="function">function</control_st> to check whether the <glossary tag="Option key">Option key</glossary>, <glossary tag="Meta key">Meta key</glossary>, or <glossary tag="Alt key">Alt key</glossary> is being pressed. You can use <b>optionKey</b> to add alternative capabilities to user actions such as clicking.</p><p/><p><b>Value:</b></p><p>The <b>optionKey</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> down if the key is pressed and up if it's not.</p><p/><p><b>Comments:</b></p><p>The <b>altKey</b>, <b>optionKey</b>, and <href tag="dictionary/function/1835.xml">metaKey</href> <glossary tag="function">functions</glossary> all <constant tag="return">return</constant> the same <function tag="value">value</function>. Which one to use is a matter of preference.</p><p/><p>The terminology varies depending on platform. Users of different operating systems may know this key as the Option key (Mac OS systems), Meta key (Unix systems), or Alt key (Windows systems).</p>
  </description>
</doc>