AftGangAglay Documentation


getkey

Parameters

Parameter Type Description
keycode int The code of the key whose state should be read.

Return Value

Type Description
int The state of the requested key - True for held, False for released.

Description

Fetches the current state of the key named by keycode - held or released. Keycodes refer to physical keys and not characters, so modifiers are reported the same as others. If the requested keycode is outside of the keymap bounds, None is instead returned.

Keycodes

This list is the subset of "basic" keycodes available for both Windows and X systems.

Name Description
KEY_CANCELControl-Break
KEY_BACKSPACEBackspace
KEY_CLEARClear Scroll
KEY_PAUSEPause/Break
KEY_ESCAPEEscape
KEY_MENUAlt/Context Menu
KEY_TABTab
KEY_RETURNReturn/Enter
KEY_CAPSLOCKCapslock
KEY_SHIFT_LLeft Shift
KEY_SHIFT_RRight Shift
KEY_CONTROL_LLeft Control
KEY_CONTROL_RRight Control
KEY_ALT_LLeft Alt
KEY_ALT_RRight Alt
KEY_KANALOCKIME Kana Mode Lock
KEY_KANASHIFTIME Kana Mode Shift
KEY_HANGULIME Hangul Mode Lock
KEY_HANJAIME Hanja Mode Lock
KEY_KANJIIME Kanji Mode Lock
KEY_SPACESpace
KEY_PRIORPage Up
KEY_NEXTPage Down
KEY_ENDEnd
KEY_HOMEHome
KEY_LEFTLeft Arrow
KEY_UPUp Arrow
KEY_RIGHTRight Arrow
KEY_DOWNDown Arrow
KEY_SELECTSelect
KEY_PRINTPrint
KEY_EXECUTEExecute
KEY_INSERTInsert
KEY_DELETEDelete
KEY_HELPHelp/F1
KEY_00
KEY_11
KEY_22
KEY_33
KEY_44
KEY_55
KEY_66
KEY_77
KEY_88
KEY_99
KEY_AA
KEY_BB
KEY_CC
KEY_DD
KEY_EE
KEY_FF
KEY_GG
KEY_HH
KEY_II
KEY_JJ
KEY_KK
KEY_LL
KEY_MM
KEY_NN
KEY_OO
KEY_PP
KEY_QQ
KEY_RR
KEY_SS
KEY_TT
KEY_UU
KEY_VV
KEY_WW
KEY_XX
KEY_YY
KEY_ZZ
KEY_META_LLeft Meta/Windows/Command
KEY_META_RRight Meta/Windows/Command
KEY_SUPER_LLeft Super/Windows/Command
KEY_SUPER_RRight Super/Windows/Command
KEY_KP_0Keypad 0
KEY_KP_1Keypad 1
KEY_KP_2Keypad 2
KEY_KP_3Keypad 3
KEY_KP_4Keypad 4
KEY_KP_5Keypad 5
KEY_KP_6Keypad 6
KEY_KP_7Keypad 7
KEY_KP_8Keypad 8
KEY_KP_9Keypad 9
KEY_KP_MULTIPLYKeypad Multiply/Asterisk
KEY_KP_ADDKeypad Add/Plus
KEY_KP_SEPARATORKeypad Separator/Decimal
KEY_KP_SUBTRACTKeypad Subtract/Minus/Dash
KEY_KP_DECIMALKeypad Decimal
KEY_KP_DIVIDEKeypad Divide/Slash
KEY_F1F1
KEY_F2F2
KEY_F3F3
KEY_F4F4
KEY_F5F5
KEY_F6F6
KEY_F7F7
KEY_F8F8
KEY_F9F9
KEY_F10F10
KEY_F11F11
KEY_F12F12
KEY_F13F13
KEY_F14F14
KEY_F15F15
KEY_F16F16
KEY_F17F17
KEY_F18F18
KEY_F19F19
KEY_F20F20
KEY_F21F21
KEY_F22F22
KEY_F23F23
KEY_F24F24
KEY_NUMLOCKNumlock
KEY_SCROLLLOCKScroll Lock
KEY_ATTNInterrupt Attention/PA1/Escape
KEY_EXSELECTExtended Select/Extension Mode Shift
KEY_CURSORSELECTCursor Select
KEY_PLAYPlay
KEY_ERASEEOFErase EOF
KEY_PA1PA1

Example

import agan

class game():
	def create(self):
		return self
	#
	def update(self):
		if(agan.getkey(agan.KEY_W)):
			agan.log("The W key is held!")
		elif(agan.getkey(agan.KEY_L)):
			agan.log("The L key is held!")
		else:
			agan.log("Neither of my keys are held :(")
	#
	def close(self):
		pass