Engine

(NOTE) Keyboard representing the physical keyboard.

Methods	Properties	Base Classes	Derived Classes
GetKeyName		eventobject
IsAnyKeyDown
IsAnyNonModifierDown
KeyIsDown
KeyIsPressed
KeyIsReleased
KeyIsUp
ToKey
ToSymbol
Valid

Properties

---

Methods

---

GetKeyName : string

Gets a string name of a particular key. |Name|Type|Description| |---|---|---| |key|Keys| |

function GetKeyName(key : Keys) : String

---

IsAnyKeyDown : boolean

Is any key in the 'Keys' enum down (not including 'Keys::Unknown', e.g. PrintScreen). |Name|Type|Description| |---|---|---|

function IsAnyKeyDown() : Boolean

---

IsAnyNonModifierDown : boolean

Excluding Ctrl, Shift, and Alt - is any key in the 'Keys' enum down (not including 'Keys::Unknown', e.g. PrintScreen). |Name|Type|Description| |---|---|---|

function IsAnyNonModifierDown() : Boolean

---

KeyIsDown : boolean

Is the particular currently down. |Name|Type|Description| |---|---|---| |key|Keys| |

function KeyIsDown(key : Keys) : Boolean

---

KeyIsPressed : boolean

Was the key pressed this frame. |Name|Type|Description| |---|---|---| |key|Keys| |

function KeyIsPressed(key : Keys) : Boolean

---

KeyIsReleased : boolean

Was the key released this frame. |Name|Type|Description| |---|---|---| |key|Keys| |

function KeyIsReleased(key : Keys) : Boolean

---

KeyIsUp : boolean

Is the particular currently up. |Name|Type|Description| |---|---|---| |key|Keys| |

function KeyIsUp(key : Keys) : Boolean

---

ToKey : Keys

Counterpart to 'ToSymbol'. Converts a key's name or symbol to the key value. Returns Keys::Unknown if key is not found. |Name|Type|Description| |---|---|---| |key|string| |

function ToKey(key : String) : Keys

---

ToSymbol : string

Convert key value to it's actual name or keyboard symbol, if it has one. Returns "Unknown" String if key is not found. |Name|Type|Description| |---|---|---| |key|Keys| |

function ToSymbol(key : Keys) : String

---

ToSymbol : string

Convert a key name to it's keyboard symbol, if it has one. Returns input String if key is not found. |Name|Type|Description| |---|---|---| |keyName|string| |

function ToSymbol(keyName : String) : String

---

Valid : boolean

Validate that the key is a Keys::Enum that is not 'Unknown', or 'None', or an integer value that doesn't map to a known Keys::Enum value. |Name|Type|Description| |---|---|---| |key|Keys| |

function Valid(key : Keys) : Boolean

---

Valid : boolean

Validate that the input string can be mapped back to an enum. |Name|Type|Description| |---|---|---| |key|string| |

function Valid(key : String) : Boolean

---