Packagecom.pblabs.engine.core
Classpublic class InputKey
InheritanceInputKey Inheritance Enumerable Inheritance Object

Enumeration class that maps friendly key names to their key code equivalent. This class should not be instantiated directly, rather, one of the constants should be used.



Public Properties
 PropertyDefined By
  defaultType : Enumerable
[override] [read-only]
InputKey
  keyCode : int
[read-only] The key code that this wraps.
InputKey
  staticTypeMap : Dictionary
[static] [read-only] A dictionary mapping the string names of all the keys to the InputKey they represent.
InputKey
  typeMap : Dictionary
[override] [read-only]
InputKey
Public Methods
 MethodDefined By
  
InputKey(keyCode:int = 0)
InputKey
  
codeToString(value:int):String
[static] Converts a key code to the string that represents it.
InputKey
 Inherited
deserialize(xml:XML):*
deserializes the object from xml.
Enumerable
 Inherited
serialize(xml:XML):void
serializes the object to XML.
Enumerable
  
stringToCode(value:String):int
[static] Converts the name of a key to the keycode it represents.
InputKey
  
stringToKey(value:String):InputKey
[static] Converts the name of a key to the InputKey it represents.
InputKey
Public Constants
 ConstantDefined By
  A : InputKey
[static]
InputKey
  ADD : InputKey
[static]
InputKey
  ALT : InputKey
[static]
InputKey
  B : InputKey
[static]
InputKey
  BACKSLASH : InputKey
[static]
InputKey
  BACKSPACE : InputKey
[static]
InputKey
  C : InputKey
[static]
InputKey
  CAPS_LOCK : InputKey
[static]
InputKey
  COLON : InputKey
[static]
InputKey
  COMMA : InputKey
[static]
InputKey
  COMMAND : InputKey
[static]
InputKey
  CONTROL : InputKey
[static]
InputKey
  D : InputKey
[static]
InputKey
  DECIMAL : InputKey
[static]
InputKey
  DELETE : InputKey
[static]
InputKey
  DIVIDE : InputKey
[static]
InputKey
  DOWN : InputKey
[static]
InputKey
  E : InputKey
[static]
InputKey
  EIGHT : InputKey
[static]
InputKey
  END : InputKey
[static]
InputKey
  ENTER : InputKey
[static]
InputKey
  ESCAPE : InputKey
[static]
InputKey
  F : InputKey
[static]
InputKey
  F1 : InputKey
[static]
InputKey
  F11 : InputKey
[static]
InputKey
  F12 : InputKey
[static]
InputKey
  F2 : InputKey
[static]
InputKey
  F3 : InputKey
[static]
InputKey
  F4 : InputKey
[static]
InputKey
  F5 : InputKey
[static]
InputKey
  F6 : InputKey
[static]
InputKey
  F7 : InputKey
[static]
InputKey
  F8 : InputKey
[static]
InputKey
  F9 : InputKey
[static]
InputKey
  FIVE : InputKey
[static]
InputKey
  FOUR : InputKey
[static]
InputKey
  G : InputKey
[static]
InputKey
  H : InputKey
[static]
InputKey
  HOME : InputKey
[static]
InputKey
  I : InputKey
[static]
InputKey
  INSERT : InputKey
[static]
InputKey
  INVALID : InputKey
[static]
InputKey
  J : InputKey
[static]
InputKey
  K : InputKey
[static]
InputKey
  L : InputKey
[static]
InputKey
  LEFT : InputKey
[static]
InputKey
  LEFT_BRACKET : InputKey
[static]
InputKey
  M : InputKey
[static]
InputKey
  MINUS : InputKey
[static]
InputKey
  MOUSE_BUTTON : InputKey
[static]
InputKey
  MOUSE_HOVER : InputKey
[static]
InputKey
  MOUSE_WHEEL : InputKey
[static]
InputKey
  MOUSE_X : InputKey
[static]
InputKey
  MOUSE_Y : InputKey
[static]
InputKey
  MULTIPLY : InputKey
[static]
InputKey
  N : InputKey
[static]
InputKey
  NINE : InputKey
[static]
InputKey
  NUM0 : InputKey
[static]
InputKey
  NUM1 : InputKey
[static]
InputKey
  NUM2 : InputKey
[static]
InputKey
  NUM3 : InputKey
[static]
InputKey
  NUM4 : InputKey
[static]
InputKey
  NUM5 : InputKey
[static]
InputKey
  NUM6 : InputKey
[static]
InputKey
  NUM7 : InputKey
[static]
InputKey
  NUM8 : InputKey
[static]
InputKey
  NUM9 : InputKey
[static]
InputKey
  NUMENTER : InputKey
[static]
InputKey
  NUM_LOCK : InputKey
[static]
InputKey
  O : InputKey
[static]
InputKey
  ONE : InputKey
[static]
InputKey
  P : InputKey
[static]
InputKey
  PAGE_DOWN : InputKey
[static]
InputKey
  PAGE_UP : InputKey
[static]
InputKey
  PAUSE : InputKey
[static]
InputKey
  PERIOD : InputKey
[static]
InputKey
  PLUS : InputKey
[static]
InputKey
  Q : InputKey
[static]
InputKey
  QUOTE : InputKey
[static]
InputKey
  R : InputKey
[static]
InputKey
  RIGHT : InputKey
[static]
InputKey
  RIGHT_BRACKET : InputKey
[static]
InputKey
  S : InputKey
[static]
InputKey
  SCROLL_LOCK : InputKey
[static]
InputKey
  SEVEN : InputKey
[static]
InputKey
  SHIFT : InputKey
[static]
InputKey
  SIX : InputKey
[static]
InputKey
  SLASH : InputKey
[static]
InputKey
  SPACE : InputKey
[static]
InputKey
  SUBTRACT : InputKey
[static]
InputKey
  T : InputKey
[static]
InputKey
  TAB : InputKey
[static]
InputKey
  THREE : InputKey
[static]
InputKey
  TILDE : InputKey
[static]
InputKey
  TWO : InputKey
[static]
InputKey
  U : InputKey
[static]
InputKey
  UP : InputKey
[static]
InputKey
  V : InputKey
[static]
InputKey
  W : InputKey
[static]
InputKey
  X : InputKey
[static]
InputKey
  Y : InputKey
[static]
InputKey
  Z : InputKey
[static]
InputKey
  ZERO : InputKey
[static]
InputKey
Property Detail
defaultTypeproperty
defaultType:Enumerable  [read-only] [override]


Implementation
    public function get defaultType():Enumerable
keyCodeproperty 
keyCode:int  [read-only]

The key code that this wraps.


Implementation
    public function get keyCode():int
staticTypeMapproperty 
staticTypeMap:Dictionary  [read-only]

A dictionary mapping the string names of all the keys to the InputKey they represent.


Implementation
    public static function get staticTypeMap():Dictionary
typeMapproperty 
typeMap:Dictionary  [read-only] [override]


Implementation
    public function get typeMap():Dictionary
Constructor Detail
InputKey()Constructor
public function InputKey(keyCode:int = 0)



Parameters
keyCode:int (default = 0)
Method Detail
codeToString()method
public static function codeToString(value:int):String

Converts a key code to the string that represents it.

Parameters

value:int

Returns
String
stringToCode()method 
public static function stringToCode(value:String):int

Converts the name of a key to the keycode it represents.

Parameters

value:String

Returns
int
stringToKey()method 
public static function stringToKey(value:String):InputKey

Converts the name of a key to the InputKey it represents.

Parameters

value:String

Returns
InputKey
Constant Detail
AConstant
public static const A:InputKey

ADDConstant 
public static const ADD:InputKey

ALTConstant 
public static const ALT:InputKey

BConstant 
public static const B:InputKey

BACKSLASHConstant 
public static const BACKSLASH:InputKey

BACKSPACEConstant 
public static const BACKSPACE:InputKey

CConstant 
public static const C:InputKey

CAPS_LOCKConstant 
public static const CAPS_LOCK:InputKey

COLONConstant 
public static const COLON:InputKey

COMMAConstant 
public static const COMMA:InputKey

COMMANDConstant 
public static const COMMAND:InputKey

CONTROLConstant 
public static const CONTROL:InputKey

DConstant 
public static const D:InputKey

DECIMALConstant 
public static const DECIMAL:InputKey

DELETEConstant 
public static const DELETE:InputKey

DIVIDEConstant 
public static const DIVIDE:InputKey

DOWNConstant 
public static const DOWN:InputKey

EConstant 
public static const E:InputKey

EIGHTConstant 
public static const EIGHT:InputKey

ENDConstant 
public static const END:InputKey

ENTERConstant 
public static const ENTER:InputKey

ESCAPEConstant 
public static const ESCAPE:InputKey

FConstant 
public static const F:InputKey

F1Constant 
public static const F1:InputKey

F11Constant 
public static const F11:InputKey

F12Constant 
public static const F12:InputKey

F2Constant 
public static const F2:InputKey

F3Constant 
public static const F3:InputKey

F4Constant 
public static const F4:InputKey

F5Constant 
public static const F5:InputKey

F6Constant 
public static const F6:InputKey

F7Constant 
public static const F7:InputKey

F8Constant 
public static const F8:InputKey

F9Constant 
public static const F9:InputKey

FIVEConstant 
public static const FIVE:InputKey

FOURConstant 
public static const FOUR:InputKey

GConstant 
public static const G:InputKey

HConstant 
public static const H:InputKey

HOMEConstant 
public static const HOME:InputKey

IConstant 
public static const I:InputKey

INSERTConstant 
public static const INSERT:InputKey

INVALIDConstant 
public static const INVALID:InputKey

JConstant 
public static const J:InputKey

KConstant 
public static const K:InputKey

LConstant 
public static const L:InputKey

LEFTConstant 
public static const LEFT:InputKey

LEFT_BRACKETConstant 
public static const LEFT_BRACKET:InputKey

MConstant 
public static const M:InputKey

MINUSConstant 
public static const MINUS:InputKey

MOUSE_BUTTONConstant 
public static const MOUSE_BUTTON:InputKey

MOUSE_HOVERConstant 
public static const MOUSE_HOVER:InputKey

MOUSE_WHEELConstant 
public static const MOUSE_WHEEL:InputKey

MOUSE_XConstant 
public static const MOUSE_X:InputKey

MOUSE_YConstant 
public static const MOUSE_Y:InputKey

MULTIPLYConstant 
public static const MULTIPLY:InputKey

NConstant 
public static const N:InputKey

NINEConstant 
public static const NINE:InputKey

NUM_LOCKConstant 
public static const NUM_LOCK:InputKey

NUM0Constant 
public static const NUM0:InputKey

NUM1Constant 
public static const NUM1:InputKey

NUM2Constant 
public static const NUM2:InputKey

NUM3Constant 
public static const NUM3:InputKey

NUM4Constant 
public static const NUM4:InputKey

NUM5Constant 
public static const NUM5:InputKey

NUM6Constant 
public static const NUM6:InputKey

NUM7Constant 
public static const NUM7:InputKey

NUM8Constant 
public static const NUM8:InputKey

NUM9Constant 
public static const NUM9:InputKey

NUMENTERConstant 
public static const NUMENTER:InputKey

OConstant 
public static const O:InputKey

ONEConstant 
public static const ONE:InputKey

PConstant 
public static const P:InputKey

PAGE_DOWNConstant 
public static const PAGE_DOWN:InputKey

PAGE_UPConstant 
public static const PAGE_UP:InputKey

PAUSEConstant 
public static const PAUSE:InputKey

PERIODConstant 
public static const PERIOD:InputKey

PLUSConstant 
public static const PLUS:InputKey

QConstant 
public static const Q:InputKey

QUOTEConstant 
public static const QUOTE:InputKey

RConstant 
public static const R:InputKey

RIGHTConstant 
public static const RIGHT:InputKey

RIGHT_BRACKETConstant 
public static const RIGHT_BRACKET:InputKey

SConstant 
public static const S:InputKey

SCROLL_LOCKConstant 
public static const SCROLL_LOCK:InputKey

SEVENConstant 
public static const SEVEN:InputKey

SHIFTConstant 
public static const SHIFT:InputKey

SIXConstant 
public static const SIX:InputKey

SLASHConstant 
public static const SLASH:InputKey

SPACEConstant 
public static const SPACE:InputKey

SUBTRACTConstant 
public static const SUBTRACT:InputKey

TConstant 
public static const T:InputKey

TABConstant 
public static const TAB:InputKey

THREEConstant 
public static const THREE:InputKey

TILDEConstant 
public static const TILDE:InputKey

TWOConstant 
public static const TWO:InputKey

UConstant 
public static const U:InputKey

UPConstant 
public static const UP:InputKey

VConstant 
public static const V:InputKey

WConstant 
public static const W:InputKey

XConstant 
public static const X:InputKey

YConstant 
public static const Y:InputKey

ZConstant 
public static const Z:InputKey

ZEROConstant 
public static const ZERO:InputKey