altKey

returns the state of the Alt key.

# Metadata

Platforms: desktop, server OS: mac, windows, linux Introduced: 1.0 Security:

# Syntax

the altKey

# Examples

put the altKey into keyState

if the altKey is down then exit mouseUp

repeat until altKey() = up

# Description

Use the altKey function to check whether the Alt key, Meta key, or Option key is being pressed. You can use altKey to add alternative capabilities to user actions such as clicking.

The altKey, optionKey, and metaKey functions all return the same value. Which one to use is a matter of preference. 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).

# Tags

ui,

# See

- **constant:** return - **message:** optionKeyDown - **function:** optionKey, value, keysDown - **control structure:** function - **glossary:** Meta key, return, function, Alt key, Option key