key

Documentation

Overview

Package key provides functions for handling virtual keyboard input. Useful for writing tools or games using mouse + keyboard combination. For basic game control please consider virtual controller instead (pi.Btn and pi.Btnp).

Virtual keyboard is inspired by US keyboard layout:

ESC F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12
`  1  2  3  4  5  6  7  8  9  0  -  =  <--
TAB Q  W  E  R  T  Y  U  I  O  P  [   ]  \
CAP  A  S  D  F  G  H  J  K  L  ;  ' ENTER
SHIFT Z  X  C  V  B  N  M  ,  .  /    ↑
CTRL ALT        SPACE              ←  ↓  →

This package is experimental. Can be changed in the future.

Index

• Variables
• func Btn(b Button) bool
• func Btnp(b Button) bool
• type Button
  • func (b Button) String() string

Variables

var Duration [97]uint

Duration has info how many frames in a row a keyboard button was pressed: Index of array is equal to key button constant, for example Duration[1] has button duration for Shift key.

Functions

func Btn

func Btn(b Button) bool

Btn returns true if the keyboard button is being pressed at this moment.

You can use button constants defined in the package or pass runes as a button parameter, for example:

key.Btn(key.A)
key.Btn('A')
key.Btn('a')

All these calls have same effect.

func Btnp

func Btnp(b Button) bool

Btnp returns true when the keyboard button has just been pressed. It also returns true after the next 15 frames, and then every 4 frames.

Types

type Button

type Button int

const (
	Shift        Button = 1
	Ctrl         Button = 3
	Alt          Button = 5 // Please note that on some keyboard layouts on Windows the right alt is a combination of Ctrl+Alt
	Cap          Button = 7
	Back         Button = '\b' // 8
	Tab          Button = '\t' // 9
	Enter        Button = '\n' // 10
	F1           Button = 11
	F2           Button = 12
	F3           Button = 13
	F4           Button = 14
	F5           Button = 15
	F6           Button = 16
	F7           Button = 17
	F8           Button = 18
	F9           Button = 19
	F10          Button = 20
	F11          Button = 21
	F12          Button = 22
	Left         Button = 23
	Right        Button = 24
	Up           Button = 25
	Down         Button = 26
	Esc          Button = 27
	Space        Button = ' '  // 32
	Apostrophe   Button = '\'' // 39
	Comma        Button = ','  // 44
	Minus        Button = '-'  // 45
	Period       Button = '.'  // 46
	Slash        Button = '/'  // 47
	Digit0       Button = '0'  // 48
	Digit1       Button = '1'  // 49
	Digit2       Button = '2'  // 50
	Digit3       Button = '3'  // 51
	Digit4       Button = '4'  // 52
	Digit5       Button = '5'  // 53
	Digit6       Button = '6'  // 54
	Digit7       Button = '7'  // 55
	Digit8       Button = '8'  // 56
	Digit9       Button = '9'  // 57
	Semicolon    Button = ';'  // 59
	Equal        Button = '='  // 61
	A            Button = 'A'  // 65
	B            Button = 'B'  // 66
	C            Button = 'C'  // 67
	D            Button = 'D'  // 68
	E            Button = 'E'  // 69
	F            Button = 'F'  // 70
	G            Button = 'G'  // 71
	H            Button = 'H'  // 72
	I            Button = 'I'  // 73
	J            Button = 'J'  // 74
	K            Button = 'K'  // 75
	L            Button = 'L'  // 76
	M            Button = 'M'  // 77
	N            Button = 'N'  // 78
	O            Button = 'O'  // 79
	P            Button = 'P'  // 80
	Q            Button = 'Q'  // 81
	R            Button = 'R'  // 82
	S            Button = 'S'  // 83
	T            Button = 'T'  // 84
	U            Button = 'U'  // 85
	V            Button = 'V'  // 86
	W            Button = 'W'  // 87
	X            Button = 'X'  // 88
	Y            Button = 'Y'  // 89
	Z            Button = 'Z'  // 90
	BracketLeft  Button = '['  // 91
	Backslash    Button = '\\' // 92
	BracketRight Button = ']'  // 93
	Backquote    Button = '`'  // 96
)

func (Button) String

func (b Button) String() string