Game Keys (Range.events)#

Intro#

This module holds key constants for the SCA_KeyboardSensor.

# Set a connected keyboard sensor to accept F1
import Range

co = Range.logic.getCurrentController()
# 'Keyboard' is a keyboard sensor
sensor = co.sensors["Keyboard"]
sensor.key = Range.events.F1KEY

# Do the all keys thing
import Range

co = Range.logic.getCurrentController()
# 'Keyboard' is a keyboard sensor
sensor = co.sensors["Keyboard"]

for key, input in sensor.inputs:
     # key[0] == Range.events.keycode = event.type, key[1] = input
     if Range.logic.KX_INPUT_JUST_ACTIVATED in input.queue:
             if key == Range.events.WKEY:
                     # Activate Forward!
             if key == Range.events.SKEY:
                     # Activate Backward!
             if key == Range.events.AKEY:
                     # Activate Left!
             if key == Range.events.DKEY:
                     # Activate Right!

# The all keys thing without a keyboard sensor (but you will
# need an always sensor with pulse mode on)
import Range

# Just shortening names here
keyboard = Range.logic.keyboard
JUST_ACTIVATED = Range.logic.KX_INPUT_JUST_ACTIVATED

if JUST_ACTIVATED in keyboard.inputs[Range.events.WKEY].queue:
     print("Activate Forward!")
if JUST_ACTIVATED in keyboard.inputs[Range.events.SKEY].queue:
     print("Activate Backward!")
if JUST_ACTIVATED in keyboard.inputs[Range.events.AKEY].queue:
     print("Activate Left!")
if JUST_ACTIVATED in keyboard.inputs[Range.events.DKEY].queue:
     print("Activate Right!")

Functions#

Range.events.EventToString(event)#

Return the string name of a key event. Will raise a ValueError error if its invalid.

Parameters:

event (int) – key event constant from Range.events or the keyboard sensor.

Return type:

string

Range.events.EventToCharacter(event, shift)#

Return the string name of a key event. Returns an empty string if the event cant be represented as a character.

Parameters:

  • event (int) – key event constant from Range.events or the keyboard sensor.

  • shift (bool) – set to true if shift is held.

Return type:

string

Constants#

Mouse Keys#

Range.events.LEFTMOUSE#
Value:

116

Range.events.MIDDLEMOUSE#
Value:

117

Range.events.RIGHTMOUSE#
Value:

118

Range.events.LEFTTHUMBMOUSE#
Value:

119

Range.events.RIGHTTHUMBMOUSE#
Value:

120

Range.events.BUTTON6MOUSE#
Value:

121

Range.events.BUTTON7MOUSE#
Value:

122

Range.events.WHEELUPMOUSE#
Value:

124

Range.events.WHEELDOWNMOUSE#
Value:

125

Range.events.MOUSEX#
Value:

126

Range.events.MOUSEY#
Value:

127

Alphabet Keys#

Range.events.AKEY#
Value:

23

Range.events.BKEY#
Value:

24

Range.events.CKEY#
Value:

25

Range.events.DKEY#
Value:

26

Range.events.EKEY#
Value:

27

Range.events.FKEY#
Value:

28

Range.events.GKEY#
Value:

29

Range.events.HKEY#
Value:

30

Range.events.IKEY#
Value:

31

Range.events.JKEY#
Value:

32

Range.events.KKEY#
Value:

33

Range.events.LKEY#
Value:

34

Range.events.MKEY#
Value:

35

Range.events.NKEY#
Value:

36

Range.events.OKEY#
Value:

37

Range.events.PKEY#
Value:

38

Range.events.QKEY#
Value:

39

Range.events.RKEY#
Value:

40

Range.events.SKEY#
Value:

41

Range.events.TKEY#
Value:

42

Range.events.UKEY#
Value:

43

Range.events.VKEY#
Value:

44

Range.events.WKEY#
Value:

45

Range.events.XKEY#
Value:

46

Range.events.YKEY#
Value:

47

Range.events.ZKEY#
Value:

48

Number Keys#

Range.events.ZEROKEY#
Value:

13

Range.events.ONEKEY#
Value:

14

Range.events.TWOKEY#
Value:

15

Range.events.THREEKEY#
Value:

16

Range.events.FOURKEY#
Value:

17

Range.events.FIVEKEY#
Value:

18

Range.events.SIXKEY#
Value:

19

Range.events.SEVENKEY#
Value:

20

Range.events.EIGHTKEY#
Value:

21

Range.events.NINEKEY#
Value:

22

Modifiers Keys#

Range.events.CAPSLOCKKEY#
Value:

49

Range.events.LEFTCTRLKEY#
Value:

50

Range.events.LEFTALTKEY#
Value:

51

Range.events.RIGHTALTKEY#
Value:

52

Range.events.RIGHTCTRLKEY#
Value:

53

Range.events.RIGHTSHIFTKEY#
Value:

54

Range.events.LEFTSHIFTKEY#
Value:

55

Arrow Keys#

Range.events.LEFTARROWKEY#
Value:

69

Range.events.DOWNARROWKEY#
Value:

70

Range.events.RIGHTARROWKEY#
Value:

71

Range.events.UPARROWKEY#
Value:

72

Numberpad Keys#

Range.events.PAD0#
Value:

84

Range.events.PAD1#
Value:

77

Range.events.PAD2#
Value:

73

Range.events.PAD3#
Value:

78

Range.events.PAD4#
Value:

74

Range.events.PAD5#
Value:

79

Range.events.PAD6#
Value:

75

Range.events.PAD7#
Value:

80

Range.events.PAD8#
Value:

76

Range.events.PAD9#
Value:

71

Range.events.PADPERIOD#
Value:

82

Range.events.PADSLASHKEY#
Value:

83

Range.events.PADASTERKEY#
Value:

9

Range.events.PADMINUS#
Value:

85

Range.events.PADENTER#
Value:

86

Range.events.PADPLUSKEY#
Value:

87

Function Keys#

Range.events.F1KEY#
Value:

88

Range.events.F2KEY#
Value:

89

Range.events.F3KEY#
Value:

90

Range.events.F4KEY#
Value:

91

Range.events.F5KEY#
Value:

92

Range.events.F6KEY#
Value:

93

Range.events.F7KEY#
Value:

94

Range.events.F8KEY#
Value:

95

Range.events.F9KEY#
Value:

96

Range.events.F10KEY#
Value:

97

Range.events.F11KEY#
Value:

98

Range.events.F12KEY#
Value:

99

Range.events.F13KEY#
Value:

100

Range.events.F14KEY#
Value:

101

Range.events.F15KEY#
Value:

102

Range.events.F16KEY#
Value:

103

Range.events.F17KEY#
Value:

104

Range.events.F18KEY#
Value:

105

Range.events.F19KEY#
Value:

106

Other Keys#

Range.events.ACCENTGRAVEKEY#
Value:

63

Range.events.BACKSLASHKEY#
Value:

65

Range.events.BACKSPACEKEY#
Value:

59

Range.events.COMMAKEY#
Value:

10

Range.events.DELKEY#
Value:

60

Range.events.ENDKEY#
Value:

113

Range.events.EQUALKEY#
Value:

66

Range.events.ESCKEY#
Value:

56

Range.events.HOMEKEY#
Value:

110

Range.events.INSERTKEY#
Value:

109

Range.events.LEFTBRACKETKEY#
Value:

67

Range.events.LINEFEEDKEY#
Value:

58

Range.events.MINUSKEY#
Value:

11

Range.events.PAGEDOWNKEY#
Value:

112

Range.events.PAGEUPKEY#
Value:

111

Range.events.PAUSEKEY#
Value:

108

Range.events.PERIODKEY#
Value:

12

Range.events.QUOTEKEY#
Value:

62

Range.events.RIGHTBRACKETKEY#
Value:

68

Range.events.RETKEY#

Warning

Deprecated, use Range.events.ENTERKEY() instead.

Value:

7

Range.events.ENTERKEY#
Value:

7

Range.events.SEMICOLONKEY#
Value:

61

Range.events.SLASHKEY#
Value:

64

Range.events.SPACEKEY#
Value:

8

Range.events.TABKEY#
Value:

57