Adobe ATMOSPHERE User Manual page 281

Local Callbacks
onEvent(keyEvent)
A method which defi nes what will happen when a key event occurs. A 'KeyEvent' object is returned which
possesses the key code for the key pressed, as well as several other properties.
myEventHandler = KeyEventHandler();
myEventHandler.setFilterOnKeyDown();
myEventHandler.onEvent = function(keyEvent)
{
chat.print("Key Code = " + keyEvent.keyCode);
}
The additional 'keyEvent' properties are as follows:
keyCode // the numeric value of the key pressed (see table below)
KeyDown // true for key down event, and false for key up
metaKey1Down // true if 'Shift' key was also held down during key event
metaKey2Down // true if 'Ctrl' key was also held down during key event
metaKey3Down // (currently not used)
metaKey4Down // (currently not used)
See the description for KeyEvent below for more details.
Local Methods
By default, a KeyEventHandler responds to all key events. Filtering Methods are therefore provided below to
limit the scope of key events and allow customized responses.
setFilterEvent()
Causes the handler to respond to all keyboard events.
myEventHandler = KeyEventHandler();
myEventHandler.setFilterEvent();
myEventHandler.onEvent = function(keyEvent)
{
chat.print("Key Code = " + keyEvent.keyCode);
}
setFilterOnKeyDown()
Causes the handler to respond to all key down events only.
myEventHandler = KeyEventHandler();
myEventHandler.setFilterOnKeyDown();
myEventHandler.onEvent = function(keyEvent)
{
chat.print("Key down key code = " + keyEvent.keyCode);
}
setFilterOnKeyUp()
Causes the handler to respond to all key up events only.
269
ADOBE ATMOSPHERE
User Guide