Key.getCode()

Availability

Flash Player 5.

Usage

Key.getCode() : Number

Parameters

None.

Returns

A number; an integer that represents the key code of the last key pressed.

Description

Method; returns the key code value of the last key pressed. To match the returned key code value with the key on a standard keyboard, see Appendix C, "Keyboard Keys and Key Code Values". in Using ActionScript in Flash.

Example

The following example calls the getCode() method any time a key is pressed. The example creates a listener object named keyListener and defines a function that responds to the onKeyDown event by calling Key.getCode(). For more information, see "Using event listeners" in Using ActionScript in Flash. The keyListener object is then registered to the Key object, which broadcasts the onKeyDown message whenever a key is pressed while the SWF file plays.

var keyListener:Object = new Object();
keyListener.onKeyDown = function() {
   trace("The ASCII code for the last key typed is: "+Key.getAscii());
};
Key.addListener(keyListener);

When using this example, make sure that you select Control > Disable Keyboard Shortcuts in the test environment.

The following example adds a call to Key.getAscii() to show how the two methods differ. The main difference is that Key.getAscii() differentiates between uppercase and lowercase letters, and Key.getCode() does not.

var keyListener:Object = new Object();
keyListener.onKeyDown = function() {
   trace("For the last key typed:");
   trace("\tThe Key code is: "+Key.getCode());
   trace("\tThe ASCII value is: "+Key.getAscii());
   trace("");
};
Key.addListener(keyListener);

When using this example, make sure that you select Control > Disable Keyboard Shortcuts in the test environment.

Comments

Add Comment

Mister Neb said on Aug 18, 2004 at 4:57 PM :

This topic needs an example of comparing Key.getCode() against one of the Key.KEYNAME constants, just to make it clear that this is the usual way of using the Key.KEYNAME constants. This topic almost achieves this goal via the cross-reference to Appendix C, but even better would be an example like: if (Key.getCode() == Key.ENTER) { ... }

Francis Cheng said on Aug 19, 2004 at 1:01 PM :

Moreover, the first example uses getASCII() instead of getCode(). The following example uses Key.getCode() and a Key constant (this will replace the first example in the Example section in the next help update):
var keyListener:Object = new Object();
keyListener.onKeyDown = function() {
// compare return value of getCode() to constant
if (Key.getCode() == Key.ENTER) {
trace ("Virtual key code: "+Key.getCode()+" (ENTER key)");
}
else {
trace("Virtual key code: "+Key.getCode());
}
};
Key.addListener(keyListener);

nectil said on Nov 18, 2004 at 6:59 AM :

Mac Users: Be carefull with the Key.getCode() function because it's
completely Buggy when the CONTROL key is down, the function return a
'-1' code!

And PC Users, be carefull too, because the CONTROL modifier keyUp
event MAY OCCUR before the other key... so it's not possible to be sure
of such an expression to know if the user made a control-enter !!! :

if (Key.getCode() == Key.ENTER && Key.isDown(Key.CONTROL))

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/mx2004/main_7_2/00001387.html

Add Comment