<doc>

<legacy_id>2041</legacy_id>

<name>altKey</name>

<type>function</type>

<syntax>

<example>the altKey</example>

<example>altKey()</example>

</syntax>

<synonyms>

</synonyms>

<summary><glossary tag="return">Returns</glossary> the state of the <glossary tag="Alt key">Alt key</glossary>.</summary>

<examples>

<example>put the altKey into keyState</example>

<example>if the altKey is down then exit mouseUp</example>

<example><p>repeat until altKey() = up</p></example>

</examples>

<history>

<introduced version="1.0">Added.</introduced>

<deprecated version=""></deprecated>

<removed version=""></removed>

</history>

<objects>

</objects>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<classification>

<category>User Interaction</category>

</classification>

<references>

<function tag="keysDown">keysDown Function</function>

<message tag="optionKeyDown">optionKeyDown Message</message>

</references>

<description>

<overview>Use the <b>altKey</b> <control_st tag="function">function</control_st> to check whether the <glossary tag="Alt key">Alt key</glossary>, <glossary tag="Meta key">Meta key</glossary>, or Option key is being pressed. You can use <b>altKey</b> to add alternative capabilities to user actions such as clicking.</overview>

<parameters></parameters>

<value>The <b>altKey</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.</value>

<comments>The <b>altKey</b>, <function tag="optionKey">optionKey</function>, and metaKey <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>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></comments>

</description>

</doc>