G-L > Key (object) |  |

Key (object)

key, key object, built-in object

The Key object is a top-level object that you can access without using a constructor. Use the methods of the Key object to build an interface that can be controlled by a user with a standard keyboard. The properties of the Key object are constants representing the keys most commonly used to control games. For a complete list of key code values, see the appendix Keyboard Keys and Key Code Values in Using Flash.

Example

The following script uses the Key object to identify keys on any keyboard so that the user can control a movie clip.

    onClipEvent (enterFrame) {
    	if(Key.isDown(Key.RIGHT)) {
    		this._x=_x+10;
    	} else if (Key.isDown(Key.DOWN)) {
    		this._y=_y+10;
    	}
    }

Method summary for the Key object

Method | Description
--- | ---
`Key.addListener` | Registers an object to receive notification when the `onKeyDown` and `onKeyUp` methods are invoked.
`Key.getAscii` | Returns the ASCII value of the last key pressed.
`Key.getCode` | Returns the virtual key code of the last key pressed.
`Key.isDown` | Returns `true` if the key specified in the parameter is pressed.
`Key.isToggled` | Returns `true` if the Num Lock or Caps Lock key is activated.
`Key.removeListener` | Removes an object that was previously registered with `addListener`.

Property summary for the Key object

All of the properties for the Key object are constants.

Property | Description
--- | ---
`Key.BACKSPACE` | Constant associated with the key code value for the Backspace key (8).
`Key.CAPSLOCK` | Constant associated with the key code value for the Caps Lock key (20).
`Key.CONTROL` | Constant associated with the key code value for the Control key (17).
`Key.DELETEKEY` | Constant associated with the key code value for the Delete key (46).
`Key.DOWN` | Constant associated with the key code value for the Down Arrow key (40).
`Key.END` | Constant associated with the key code value for the End key (35).
`Key.ENTER` | Constant associated with the key code value for the Enter key (13).
`Key.ESCAPE` | Constant associated with the key code value for the Escape key (27).
`Key.HOME` | Constant associated with the key code value for the Home key (36).
`Key.INSERT` | Constant associated with the key code value for the Insert key (45).
`Key.LEFT` | Constant associated with the key code value for the Left Arrow key (37).
`Key.PGDN` | Constant associated with the key code value for the Page Down key (34).
`Key.PGUP` | Constant associated with the key code value for the Page Up key (33).
`Key.RIGHT` | Constant associated with the key code value for the Right Arrow key (39).
`Key.SHIFT` | Constant associated with the key code value for the Shift key (16).
`Key.SPACE` | Constant associated with the key code value for the Spacebar (32).
`Key.TAB` | Constant associated with the key code value for the Tab key (9).
`Key.UP` | Constant associated with the key code value for the Up Arrow key (38).

Listener summary for the Key object

Method | Description
--- | ---
`Key.onKeyDown` | Notified when a key is pressed.
`Key.onKeyUp` | Notified when a key is released.