Module Musician.KeyboardUtils
Keyboard utility functions
Functions
| Musician.KeyboardUtils.GetEmptyMapping () | Return a brand new empty mapping |
| Musician.KeyboardUtils.GetKey (keyValue) | Return the physical key mapped to the actual key value. |
| Musician.KeyboardUtils.GetKeyName (key) | Return the localized name of the physical key, base on the current mapping |
| Musician.KeyboardUtils.GetKeyValue (key) | Return the actual key value mapped to the physical key. |
| Musician.KeyboardUtils.GetKeyValueName (keyValue) | Return the localized name of the key value |
| Musician.KeyboardUtils.GetMapping () | Return the current keyboard mapping |
| Musician.KeyboardUtils.GetReverseMapping () | Return the current reverse mapping |
| Musician.KeyboardUtils.Init () | Init |
| Musician.KeyboardUtils.KeyboardIsConfigured () | Return true if the keyboard has been configured |
| Musician.KeyboardUtils.SetMapping (mapping) | Set the keyboard mapping |
Functions
- Musician.KeyboardUtils.GetEmptyMapping ()
-
Return a brand new empty mapping
Returns:
-
(table) key value => physical key
- Musician.KeyboardUtils.GetKey (keyValue)
-
Return the physical key mapped to the actual key value.
Parameters:
- keyValue (string) key value
Returns:
-
(string) physical key
- Musician.KeyboardUtils.GetKeyName (key)
-
Return the localized name of the physical key, base on the current mapping
Parameters:
- key (string) physical key
Returns:
-
(string)
- Musician.KeyboardUtils.GetKeyValue (key)
-
Return the actual key value mapped to the physical key.
Parameters:
- key (string) physical key
Returns:
-
(string) key value
- Musician.KeyboardUtils.GetKeyValueName (keyValue)
-
Return the localized name of the key value
Parameters:
- keyValue (string) key value
Returns:
-
(string)
- Musician.KeyboardUtils.GetMapping ()
-
Return the current keyboard mapping
Returns:
-
(table) key value => physical key
- Musician.KeyboardUtils.GetReverseMapping ()
-
Return the current reverse mapping
Returns:
-
(table) physical key => key value
- Musician.KeyboardUtils.Init ()
- Init
- Musician.KeyboardUtils.KeyboardIsConfigured ()
-
Return true if the keyboard has been configured
Returns:
-
(boolean)
- Musician.KeyboardUtils.SetMapping (mapping)
-
Set the keyboard mapping
Parameters:
- mapping (table) key value => physical key