Keyboard Methods |
The Keyboard type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | GetAnyButton |
Gets the button held state of any hardware button. This will return TRUE as long as any button is held.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetAnyButtonChanged |
Returns true if any button has changed state from the previous frame to the current.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetAnyButtonDown |
Gets the button just pressed state of any hardware button. This will only return TRUE only on the first frame the button is pressed
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetAnyButtonPrev |
Gets the previous button held state of any hardware button. This will return TRUE if any button was held in the previous frame.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetAnyButtonUp |
Gets the button just released state of any hardware button. This will only return TRUE only on the first frame the button is released
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButton |
Gets the button held state of the hardware button at the specified index. This will return TRUE as long as the button is held.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonById |
Gets the button held state of the hardware button at the specified element identifier id. This will return TRUE as long as the button is held.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonChanged |
Returns true if the button has changed state from the previous frame to the current.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonDoublePressDown(Int32) |
Gets the double press down state of the button at the specified index.
This will return TRUE only on the first frame the double press is detected.
This will use the default double press speed.
(Inherited from Controller) |
| GetButtonDoublePressDown(Int32, Single) |
Gets the double press down state of the button at the specified index.
This will return TRUE only on the first frame the double press is detected.
(Inherited from Controller) |
| GetButtonDoublePressDownById(Int32) |
Gets the double press down state of the button at the specified element identifier id.
This will return TRUE only on the first frame the double press is detected.
This will use the default double press speed.
(Inherited from Controller) |
| GetButtonDoublePressDownById(Int32, Single) |
Gets the double press down state of the button at the specified element identifier id.
This will return TRUE only on the first frame the double press is detected.
(Inherited from Controller) |
| GetButtonDoublePressHold(Int32) |
Gets the double press and hold state of the button at the specified index.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
This will use the default double press speed.
(Inherited from Controller) |
| GetButtonDoublePressHold(Int32, Single) |
Gets the double press and hold state of the button at the specified index.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
(Inherited from Controller) |
| GetButtonDoublePressHoldById(Int32) |
Gets the double press and hold state of the button at the specified element identifier id.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
This will use the default double press speed.
(Inherited from Controller) |
| GetButtonDoublePressHoldById(Int32, Single) |
Gets the double press and hold state of the button at the specified element identifier id.
This will return TRUE after the double press is detected and for as long as the button is held thereafter.
(Inherited from Controller) |
| GetButtonDown |
Gets the button just pressed state of the hardware button at the specified index. This will only return TRUE only on the first frame the button is pressed
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonDownById |
Gets the button just pressed state of the hardware button at the specified element identifier id. This will only return TRUE only on the first frame the button is pressed
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonIndexById |
Gets the index of the Button with the specified element idenfitier id.
(Inherited from Controller) |
| GetButtonIndexByKeyCode | Gets the Button index that corresponds to the specified KeyCode. |
| GetButtonLastTimePressed |
Gets the last timestamp the button at index was active.
(Inherited from Controller) |
| GetButtonLastTimePressedById |
Gets the last timestamp the button with the element identifier id was active.
(Inherited from Controller) |
| GetButtonLastTimeUnpressed |
Gets the last timestamp the button at index was inactive.
(Inherited from Controller) |
| GetButtonLastTimeUnpressedById |
Gets the last timestamp the button with the element identifier id was inactive.
(Inherited from Controller) |
| GetButtonPrev |
Gets the previous button held state of the hardware button at the specified index. This will return TRUE if the button was held in the previous frame.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonPrevById |
Gets the previous button held state of the hardware button at the specified element identifier id. This will return TRUE if the button was held in the previous frame.
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonTimePressed |
Gets the length of time the button at index has been active.
(Inherited from Controller) |
| GetButtonTimePressedById |
Gets the length of time the button with the element identifier id has been active.
(Inherited from Controller) |
| GetButtonTimeUnpressed |
Gets the length of time the button at index has been inactive.
(Inherited from Controller) |
| GetButtonTimeUnpressedById |
Gets the length of time the button with the element identifier id has been inactive.
(Inherited from Controller) |
| GetButtonUp |
Gets the button just released state of the hardware button at the specified index. This will only return TRUE only on the first frame the button is released
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetButtonUpById |
Gets the button just released state of the hardware button at the specified element identifier id. This will only return TRUE only on the first frame the button is released
This does not take into acount any controller mapping or Actions -- this is the unmapped physical button value only.
Use the Player class to get button values mapped to Actions.
(Inherited from Controller) |
| GetCompoundElementById |
Gets the Compound Element with the specified element identifier id.
(Inherited from Controller) |
| GetCompundElementById |
OBSOLETE: This method is deprecated. Use GetCompoundElementById(Int32) instead.
Gets the Compound Element with the specified element identifier id.
(Inherited from Controller) Obsolete |
| GetElementById |
Gets the Element with the specified element identifier id.
(Inherited from Controller) |
| GetElementIdentifierById |
Gets a Controller Element Identifier by id.
(Inherited from Controller) |
| GetElementIdentifierByKeyCode | Gets the Controller Element Identifier corresponding to the specified KeyCode. |
| GetExtensionT |
Gets an object used to access controller and platform-specific controller functions.
(Inherited from Controller) |
| GetKey | |
| GetKeyCodeByButtonIndex | Gets the KeyCode of the key at the specified button index. |
| GetKeyCodeById | Gets the KeyCode of the key with the specified element identifier id. |
| GetKeyDoublePressDown(KeyCode) | |
| GetKeyDoublePressDown(KeyCode, Single) | |
| GetKeyDoublePressHold(KeyCode) | |
| GetKeyDoublePressHold(KeyCode, Single) | |
| GetKeyDown | |
 | GetKeyName(KeyCode) | Gets the display name for the specified key code. This may return words and/or symbols for some keys. Example: "Keypad 0", ";", "Back Quote". The returned value will be localized if localization is in use. |
| GetKeyName(KeyCode, ModifierKeyFlags) | Creates a string containing all display names for a key and modifier key combination. This may return words and/or symbols for some keys. Example: "Keypad 0", ";", "Back Quote". Modifier keys will precede the primary key. Each key will be separated by the + character. If you need RTL support, you must build the string yourself using GetModifierKeyName(ModifierKey) and GetKeyName(KeyCode). The returned value will be localized if localization is in use. |
| GetKeyPrev | |
| GetKeyTimePressed | |
| GetKeyTimeUnpressed | |
| GetKeyUp | |
| GetLastTimeActive |
Gets the last timestamp any button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from Controller) |
| GetLastTimeActive(Boolean) |
Gets the last timestamp any button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from Controller) |
| GetLastTimeAnyButtonChanged |
Gets the last timestamp any button's state changed.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from Controller) |
| GetLastTimeAnyButtonPressed |
Gets the last timestamp any button was active.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from Controller) |
| GetLastTimeAnyElementChanged |
Gets the last timestamp any element changed state.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
(Inherited from Controller) |
| GetLastTimeAnyElementChanged(Boolean) |
Gets the last timestamp any element changed state.
NOTE: If comparing time against current time, always compare to ReInput.time.unscaledTime.
Use raw axis values (Inherited from Controller) |
| GetModifierKey | |
| GetModifierKeyDown | |
| GetModifierKeyGlyph | Gets the glyph for the specified modifier key. This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier. |
| GetModifierKeyName(ModifierKey) | Gets the display name for the specified modifier key. This will return the long name for modifier keys (Control instead of Ctrl). To get the short name, use the ModifierKeyFlagsToString(ModifierKeyFlags, Boolean) overload. The returned value will be localized if localization is in use. |
| GetModifierKeyName(ModifierKey, Boolean) | Gets the display name for the specified modifier key. The returned value will be localized if localization is in use. |
| GetModifierKeyPrev | |
| GetModifierKeyTimePressed | |
| GetModifierKeyTimeUnpressed | |
| GetModifierKeyUp | |
| GetTemplate(Guid) |
Gets a Controller Template by type GUID.
(Inherited from Controller) |
| GetTemplate(Type) |
Gets a Controller Template by type.
(Inherited from Controller) |
| GetTemplateT |
Gets the first Controller Template that implements the specified type.
Note that it is possible to have multiple Controller Templates that implement a specific type of interface
such as IControllerTemplate. You should use the most specific interface type possible such as IDualAnalogGamepadTemplate instead,
which would be guaranteed to only apply to a single Controller Template.
(Inherited from Controller) |
| ImplementsTemplate(Guid) |
Determines if the Controller implements a Controller Template by type GUID.
(Inherited from Controller) |
| ImplementsTemplate(Type) |
Determines if the Controller implements a Controller Template by type.
(Inherited from Controller) |
| ImplementsTemplateT |
Determines if the Controller implements a Controller Template by type.
(Inherited from Controller) |
| IsModifierKey | |
| KeyCodeToModifierKey | Gets the modifier key for the specified key code. For example, KeyCode.LeftShift will return ModifierKey.Shift. |
| KeyCodeToModifierKeyFlags | Gets the modifier key flags for the specified key code. For example, KeyCode.LeftShift will return ModifierKeyFlags.LeftShift. |
| ModifierKeyFlagsContain(ModifierKeyFlags, ModifierKey) | Determines if the modifier key flags contains a specific modifier key. |
| ModifierKeyFlagsContain(ModifierKeyFlags, KeyCode) | Determines if the modifier key flags contains a specific key. |
| ModifierKeyFlagsToKeyCode | Converts modifier key flags to a key code. |
| ModifierKeyFlagsToModifierKey | Converts modifier key flags to a modifier key. |
| ModifierKeyFlagsToString(ModifierKeyFlags) | Creates a string containing all display names for a modifier key combination. Each key will be separated by the + character. This will return the long name for modifier keys (Control instead of Ctrl). To get the short name, use the ModifierKeyFlagsToString(ModifierKeyFlags, Boolean) overload. If you need RTL support, you must build the string yourself using GetModifierKeyName(ModifierKey). The returned value will be localized if localization is in use. |
| ModifierKeyFlagsToString(ModifierKeyFlags, Boolean) | Creates a string containing all display names for a modifier key combination. Each key will be separated by the + character. If you need RTL support, you must build the string yourself using GetModifierKeyName(ModifierKey). The returned value will be localized if localization is in use. |
| ModifierKeyToModifierKeyFlags | Converts a modifier key to modifier key flags. |
| PollForAllButtons | (Overrides ControllerPollForAllButtons) |
| PollForAllButtonsDown | (Overrides ControllerPollForAllButtonsDown) |
| PollForAllElements | (Inherited from Controller) |
| PollForAllElementsDown | (Inherited from Controller) |
| PollForAllKeys | |
| PollForAllKeysDown | |
| PollForFirstButton | (Overrides ControllerPollForFirstButton) |
| PollForFirstButtonDown | (Overrides ControllerPollForFirstButtonDown) |
| PollForFirstElement | (Inherited from Controller) |
| PollForFirstElementDown | (Inherited from Controller) |
| PollForFirstKey | |
| PollForFirstKeyDown |
See Also