Module igeCore.input.keyboard
indi game engine - keyboard input
Expand source code
"""
indi game engine - keyboard input
"""
import igeCore as core
class KeyCode:
KEY_NOKEY = -1
KEY_0 = 0
KEY_1 = 1
KEY_2 = 2
KEY_3 = 3
KEY_4 = 4
KEY_5 = 5
KEY_6 = 6
KEY_7 = 7
KEY_8 = 8
KEY_9 = 9
KEY_A = 10
KEY_B = 11
KEY_C = 12
KEY_D = 13
KEY_E = 14
KEY_F = 15
KEY_G = 16
KEY_H = 17
KEY_I = 18
KEY_J = 19
KEY_K = 20
KEY_L = 21
KEY_M = 22
KEY_N = 23
KEY_O = 24
KEY_P = 25
KEY_Q = 26
KEY_R = 27
KEY_S = 28
KEY_T = 29
KEY_U = 30
KEY_V = 31
KEY_W = 32
KEY_X = 33
KEY_Y = 34
KEY_Z = 35
KEY_UP = 36
KEY_RIGHT = 37
KEY_DOWN = 38
KEY_LEFT= 39
KEY_F1 = 40
KEY_F2 = 41
KEY_F3 = 42
KEY_F4 = 43
KEY_F5 = 44
KEY_F6 = 45
KEY_F7 = 46
KEY_F8 = 47
KEY_F9 = 48
KEY_F10 = 49
KEY_F11 = 50
KEY_F12 = 51
KEY_ESC = 52
KEY_TAB = 53
KEY_BACK = 54
KEY_RETURN = 55
KEY_KP0 = 56
KEY_KP1 = 57
KEY_KP2 = 58
KEY_KP3 = 59
KEY_KP4 = 60
KEY_KP5 = 61
KEY_KP6 = 62
KEY_KP7 = 63
KEY_KP8 = 64
KEY_KP9 = 65
KEY_KPPLUS = 66
KEY_KPMINUS = 67
KEY_KPDIV = 68
KEY_KPMULT = 69
KEY_KPENTER = 70
KEY_KPPERIOD = 71
KEY_PAUSE = 72
KEY_SPACE = 73
KEY_PLUS = 74
KEY_MINUS = 75
KEY_PERIOD = 76
KEY_SLASH = 77
KEY_HASH = 78
KEY_EQUAL = 79
KEY_QUOTE = 80
KEY_BACKQUOTE = 81
KEY_SEMICOLON = 82
KEY_LEFTBRACKET = 83
KEY_RIGHTBRACKET = 84
KEY_BACKSLASH = 85
KEY_COMMA = 86
KEY_INSERT = 87
KEY_DEL = 88
KEY_HOME = 89
KEY_END = 90
KEY_PAGEUP = 91
KEY_PAGEDOWN = 92
KEY_LCTRL = 93
KEY_RCTRL = 94
KEY_LALT = 95
KEY_RALT = 96
KEY_LWIN = 97
KEY_RWIN = 98
KEY_LSHIFT = 99
KEY_RSHIFT = 100
KEY_CAPSLOCK = 101
KEY_NUMLOCK = 102
KEY_COUNT = 103
class KeyModifier:
NONE = 0
CTRL = 1
ALT = 2
SHIFT = 4
class Keyboard:
"""
Class Keyboard
"""
@staticmethod
def isPressed(keyCode):
"""
Check if a key is pressed.
Parameters
----------
keyCode (int): Key Code to check
Returns
-------
True: If the key is pressed
False: If the key is not pressed
"""
return core.isKeyPressed(keyCode)
@staticmethod
def isReleased(keyCode):
"""
Check if a key is released.
Parameters
----------
keyCode (int): Key Code to check
Returns
-------
True: If the key is released
False: If the key is not released
"""
return core.isKeyReleased(keyCode)
@staticmethod
def isHold(keyCode):
"""
Check if a key is hold.
Parameters
----------
keyCode (int): Key Code to check
Returns
-------
True: If the key is hold
False: If the key is not hold
"""
return core.isKeyHold(keyCode)
@staticmethod
def getKeyChar(keyCode):
"""
Get represented character with given keyCode. It will also consider SHIFT modifier state.
Parameters
----------
keyCode (int): Key Code to check
Returns
-------
key (char): The representing character
"""
return core.getKeyChar(keyCode)
@staticmethod
def getModifier():
"""
Get the key modifier value. To check if a key modifier activated, use code below:
mod = Keyboard.getModifier()
if mod & KeyModifier.SHIFT:
print("SHIFT is activated")
Returns
-------
keyModifier (int): The key modifier value
"""
return core.getKeyModifier()Classes
class KeyCode-
Expand source code
class KeyCode: KEY_NOKEY = -1 KEY_0 = 0 KEY_1 = 1 KEY_2 = 2 KEY_3 = 3 KEY_4 = 4 KEY_5 = 5 KEY_6 = 6 KEY_7 = 7 KEY_8 = 8 KEY_9 = 9 KEY_A = 10 KEY_B = 11 KEY_C = 12 KEY_D = 13 KEY_E = 14 KEY_F = 15 KEY_G = 16 KEY_H = 17 KEY_I = 18 KEY_J = 19 KEY_K = 20 KEY_L = 21 KEY_M = 22 KEY_N = 23 KEY_O = 24 KEY_P = 25 KEY_Q = 26 KEY_R = 27 KEY_S = 28 KEY_T = 29 KEY_U = 30 KEY_V = 31 KEY_W = 32 KEY_X = 33 KEY_Y = 34 KEY_Z = 35 KEY_UP = 36 KEY_RIGHT = 37 KEY_DOWN = 38 KEY_LEFT= 39 KEY_F1 = 40 KEY_F2 = 41 KEY_F3 = 42 KEY_F4 = 43 KEY_F5 = 44 KEY_F6 = 45 KEY_F7 = 46 KEY_F8 = 47 KEY_F9 = 48 KEY_F10 = 49 KEY_F11 = 50 KEY_F12 = 51 KEY_ESC = 52 KEY_TAB = 53 KEY_BACK = 54 KEY_RETURN = 55 KEY_KP0 = 56 KEY_KP1 = 57 KEY_KP2 = 58 KEY_KP3 = 59 KEY_KP4 = 60 KEY_KP5 = 61 KEY_KP6 = 62 KEY_KP7 = 63 KEY_KP8 = 64 KEY_KP9 = 65 KEY_KPPLUS = 66 KEY_KPMINUS = 67 KEY_KPDIV = 68 KEY_KPMULT = 69 KEY_KPENTER = 70 KEY_KPPERIOD = 71 KEY_PAUSE = 72 KEY_SPACE = 73 KEY_PLUS = 74 KEY_MINUS = 75 KEY_PERIOD = 76 KEY_SLASH = 77 KEY_HASH = 78 KEY_EQUAL = 79 KEY_QUOTE = 80 KEY_BACKQUOTE = 81 KEY_SEMICOLON = 82 KEY_LEFTBRACKET = 83 KEY_RIGHTBRACKET = 84 KEY_BACKSLASH = 85 KEY_COMMA = 86 KEY_INSERT = 87 KEY_DEL = 88 KEY_HOME = 89 KEY_END = 90 KEY_PAGEUP = 91 KEY_PAGEDOWN = 92 KEY_LCTRL = 93 KEY_RCTRL = 94 KEY_LALT = 95 KEY_RALT = 96 KEY_LWIN = 97 KEY_RWIN = 98 KEY_LSHIFT = 99 KEY_RSHIFT = 100 KEY_CAPSLOCK = 101 KEY_NUMLOCK = 102 KEY_COUNT = 103Class variables
var KEY_0var KEY_1var KEY_2var KEY_3var KEY_4var KEY_5var KEY_6var KEY_7var KEY_8var KEY_9var KEY_Avar KEY_Bvar KEY_BACKvar KEY_BACKQUOTEvar KEY_BACKSLASHvar KEY_Cvar KEY_CAPSLOCKvar KEY_COMMAvar KEY_COUNTvar KEY_Dvar KEY_DELvar KEY_DOWNvar KEY_Evar KEY_ENDvar KEY_EQUALvar KEY_ESCvar KEY_Fvar KEY_F1var KEY_F10var KEY_F11var KEY_F12var KEY_F2var KEY_F3var KEY_F4var KEY_F5var KEY_F6var KEY_F7var KEY_F8var KEY_F9var KEY_Gvar KEY_Hvar KEY_HASHvar KEY_HOMEvar KEY_Ivar KEY_INSERTvar KEY_Jvar KEY_Kvar KEY_KP0var KEY_KP1var KEY_KP2var KEY_KP3var KEY_KP4var KEY_KP5var KEY_KP6var KEY_KP7var KEY_KP8var KEY_KP9var KEY_KPDIVvar KEY_KPENTERvar KEY_KPMINUSvar KEY_KPMULTvar KEY_KPPERIODvar KEY_KPPLUSvar KEY_Lvar KEY_LALTvar KEY_LCTRLvar KEY_LEFTvar KEY_LEFTBRACKETvar KEY_LSHIFTvar KEY_LWINvar KEY_Mvar KEY_MINUSvar KEY_Nvar KEY_NOKEYvar KEY_NUMLOCKvar KEY_Ovar KEY_Pvar KEY_PAGEDOWNvar KEY_PAGEUPvar KEY_PAUSEvar KEY_PERIODvar KEY_PLUSvar KEY_Qvar KEY_QUOTEvar KEY_Rvar KEY_RALTvar KEY_RCTRLvar KEY_RETURNvar KEY_RIGHTvar KEY_RIGHTBRACKETvar KEY_RSHIFTvar KEY_RWINvar KEY_Svar KEY_SEMICOLONvar KEY_SLASHvar KEY_SPACEvar KEY_Tvar KEY_TABvar KEY_Uvar KEY_UPvar KEY_Vvar KEY_Wvar KEY_Xvar KEY_Yvar KEY_Z
class KeyModifier-
Expand source code
class KeyModifier: NONE = 0 CTRL = 1 ALT = 2 SHIFT = 4Class variables
var ALTvar CTRLvar NONEvar SHIFT
class Keyboard-
Class Keyboard
Expand source code
class Keyboard: """ Class Keyboard """ @staticmethod def isPressed(keyCode): """ Check if a key is pressed. Parameters ---------- keyCode (int): Key Code to check Returns ------- True: If the key is pressed False: If the key is not pressed """ return core.isKeyPressed(keyCode) @staticmethod def isReleased(keyCode): """ Check if a key is released. Parameters ---------- keyCode (int): Key Code to check Returns ------- True: If the key is released False: If the key is not released """ return core.isKeyReleased(keyCode) @staticmethod def isHold(keyCode): """ Check if a key is hold. Parameters ---------- keyCode (int): Key Code to check Returns ------- True: If the key is hold False: If the key is not hold """ return core.isKeyHold(keyCode) @staticmethod def getKeyChar(keyCode): """ Get represented character with given keyCode. It will also consider SHIFT modifier state. Parameters ---------- keyCode (int): Key Code to check Returns ------- key (char): The representing character """ return core.getKeyChar(keyCode) @staticmethod def getModifier(): """ Get the key modifier value. To check if a key modifier activated, use code below: mod = Keyboard.getModifier() if mod & KeyModifier.SHIFT: print("SHIFT is activated") Returns ------- keyModifier (int): The key modifier value """ return core.getKeyModifier()Static methods
def getKeyChar(keyCode)-
Get represented character with given keyCode. It will also consider SHIFT modifier state.
Parameters
keyCode (int): Key Code to checkReturns
key (char): The representing characterExpand source code
@staticmethod def getKeyChar(keyCode): """ Get represented character with given keyCode. It will also consider SHIFT modifier state. Parameters ---------- keyCode (int): Key Code to check Returns ------- key (char): The representing character """ return core.getKeyChar(keyCode) def getModifier()-
Get the key modifier value. To check if a key modifier activated, use code below:
mod = Keyboard.getModifier() if mod & KeyModifier.SHIFT: print("SHIFT is activated")
Returns
keyModifier (int): The key modifier valueExpand source code
@staticmethod def getModifier(): """ Get the key modifier value. To check if a key modifier activated, use code below: mod = Keyboard.getModifier() if mod & KeyModifier.SHIFT: print("SHIFT is activated") Returns ------- keyModifier (int): The key modifier value """ return core.getKeyModifier() def isHold(keyCode)-
Check if a key is hold.
Parameters
keyCode (int): Key Code to checkReturns
True: If the key is hold False: If the key is not holdExpand source code
@staticmethod def isHold(keyCode): """ Check if a key is hold. Parameters ---------- keyCode (int): Key Code to check Returns ------- True: If the key is hold False: If the key is not hold """ return core.isKeyHold(keyCode) def isPressed(keyCode)-
Check if a key is pressed.
Parameters
keyCode (int): Key Code to checkReturns
True: If the key is pressed False: If the key is not pressedExpand source code
@staticmethod def isPressed(keyCode): """ Check if a key is pressed. Parameters ---------- keyCode (int): Key Code to check Returns ------- True: If the key is pressed False: If the key is not pressed """ return core.isKeyPressed(keyCode) def isReleased(keyCode)-
Check if a key is released.
Parameters
keyCode (int): Key Code to checkReturns
True: If the key is released False: If the key is not releasedExpand source code
@staticmethod def isReleased(keyCode): """ Check if a key is released. Parameters ---------- keyCode (int): Key Code to check Returns ------- True: If the key is released False: If the key is not released """ return core.isKeyReleased(keyCode)