optionKey

returns the state of the Option key.

# Metadata

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

# Syntax

the optionKey

# Examples

wait until the optionKey is down

put the optionKey into item 2 of keyState

# Description

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

The altKey and optionKey functions both 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:** left, return - **message:** optionKeyDown - **function:** value, keysDown, altKey - **control structure:** function - **glossary:** Alt key, Meta key, Option key, return, function