<doc>

<legacy_id>1493</legacy_id>

<name>commandKey</name>

<type>function</type>

<syntax>

<example>the commandKey</example>

<example>commandKey()</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

<synonym>cmdKey</synonym>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

<constant tag="left">left Constant</constant>

<constant tag="up">up Constant</constant>

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

<message tag="commandKeyDown">commandKeyDown 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="Command key">Command key</glossary>.</summary>

<examples>

<example>put commandKey() after keyHistory</example>

<example>if the commandKey is down then edit script of me</example>

</examples>

<description>

<p>Use the <b>commandKey</b> <control_st tag="function">function</control_st> to check whether the <glossary tag="Command key">Command key</glossary> is being pressed.</p><p/><p><b>Value:</b></p><p>The <b>commandKey</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>On Unix and Windows systems, the <b>commandKey</b> function <glossary tag="return">returns</glossary> the same <function tag="value">value</function> as the <function tag="controlKey">controlKey</function> <control_st tag="function">function</control_st>: the two <glossary tag="function">functions</glossary> are synonyms.</p>

</description>

</doc>