События клавиатуры

Человек может управлять объектами в игре в основном с помощь клавиатуры, мыши, джойстика. Когда на "манипуляторах" что-то двигается или нажимается, то возникают события определенных типов. Обработкой событий занимается модуль pygame.event, который включает ряд функций, наиболее важная из которых уже ранее рассмотренная pygame.event.get(), которая забирает из очереди произошедшие события.

В pygame, когда фиксируется то или иное событие, создается соответствующий ему объект от класса Event. Уже с этими объектами работает программа. Экземпляры данного класса имеют только свойства, у них нет методов. У всех экземпляров есть свойство type. Набор остальных свойств события зависит от значения type.

События клавиатуры могут быть двух типов (иметь одно из двух значений type) – клавиша была нажата, клавиша была отпущена. Если вы нажали клавишу и отпустили, то в очередь событий будут записаны оба. Какое из них обрабатывать, зависит от контекста игры. Если вы зажали клавишу и не отпускаете ее, то в очередь записывается только один вариант – клавиша нажата.

Событию типа "клавиша нажата" в поле type записывается числовое значение, совпадающее со значением константы pygame.KEYDOWN. Событию типа "клавиша отпущена" в поле type записывается значение, совпадающее со значением константы pygame.KEYUP.

У обоих типов событий клавиатуры есть атрибуты key и mod. В key записывается конкретная клавиша, которая была нажата или отжата. В mod – клавиши-модификаторы (Shift, Ctrl и др.), которые были зажаты в момент нажатия или отжатия обычной клавиши. У событий KEYDOWN также есть поле unicode, куда записывается символ нажатой клавиши (тип данных str).

Рассмотрим, как это работает. Пусть в центре окна имеется круг, который можно двигать по горизонтали клавишами стрелок клавиатуры:

import pygame
 
FPS = 60
W = 700  # ширина экрана
H = 300  # высота экрана
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
 
pygame.init()
sc = pygame.display.set_mode((W, H))
clock = pygame.time.Clock()
 
# координаты и радиус круга
x = W // 2
y = H // 2
r = 50
 
while 1:
    sc.fill(WHITE)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    pygame.display.update()
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            exit()
        elif i.type == pygame.KEYDOWN:
            if i.key == pygame.K_LEFT:
                x -= 3
            elif i.key == pygame.K_RIGHT:
                x += 3
 
    clock.tick(FPS)

В цикле обработки событий теперь проверяется не только событие выхода, но также нажатие клавиш. Сначала необходимо проверить тип, потому что не у всех событий есть атрибут key. Если сразу начать проверять key, то сгенерируется ошибка по той причине, что могло произойти множество событий. Например, движение мыши, у которого нет поля key. Соответственно, попытка взять значение из несуществующего поля (i.key) приведет к генерации исключения.

Часто проверку и типа и клавиши записывают в одно логическое выражение (i.type == pygame.KEYDOWN and i.key == pygame.K_LEFT). В Python так можно делать потому, что если первая часть сложного выражения возвращает ложь, то вторая часть уже не проверяется.

Если какая-либо клавиша была нажата, то проверяется, какая именно. В данном случае обрабатываются только две клавиши. В зависимости от этого меняется значение координаты x.

Проблема данного кода в том, что при выполнении программы, чтобы круг двигался, надо постоянно нажимать и отжимать клавиши. Если просто зажать их на длительный период, то объект не будет постоянно двигаться. Он сместиться только одноразово на 3 пикселя.

Так происходит потому, что событие нажатия на клавишу происходит один раз, сколь долго бы ее не держали. Это событие было забрано из очереди функцией get() и обработано. Его больше нет. Поэтому приходится генерировать новое событие, еще раз нажимая на клавишу.

Как быть, если по логике вещей надо, чтобы шар двигался до тех пор, пока клавиша зажата? Когда же она отпускается, шар должен останавливаться. Первое, что надо сделать, – это перенести изменение координаты x в основную ветку главного цикла while. В таком случае на каждой его итерации координата будет меняться, а значит шар двигаться постоянно.

Во-вторых, в цикле обработки событий нам придется следить не только за нажатием клавиши, но и ее отжатием. Когда клавиша нажимается, какая-либо переменная, играющая роль флага, должна принимать одно значение, когда клавиша отпускается эта же переменная должна принимать другое значение.

В основном теле while надо проверять значение этой переменной и в зависимости от него менять или не менять значение координаты.

import pygame
 
FPS = 60
W = 700  # ширина экрана
H = 300  # высота экрана
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
RIGHT = "to the right"
LEFT = "to the left"
STOP = "stop"
 
pygame.init()
sc = pygame.display.set_mode((W, H))
clock = pygame.time.Clock()
 
# координаты и радиус круга
x = W // 2
y = H // 2
r = 50
 
motion = STOP
 
while 1:
    sc.fill(WHITE)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    pygame.display.update()
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            exit()
        elif i.type == pygame.KEYDOWN:
            if i.key == pygame.K_LEFT:
                motion = LEFT
            elif i.key == pygame.K_RIGHT:
                motion = RIGHT
        elif i.type == pygame.KEYUP:
            if i.key in [pygame.K_LEFT, pygame.K_RIGHT]:
                motion = STOP
 
    if motion == LEFT:
        x -= 3
    elif motion == RIGHT:
        x += 3
 
    clock.tick(FPS)

Использовать константы не обязательно, можно сразу присваивать строки или даже числа (например, motion = 1 обозначает движение вправо, -1 – влево, 0 – остановка). Однако константы позволяют легче понимать и обслуживать в дальнейшем код, делают его более информативным. Лучше привыкнуть к такому стилю.

Должно проверяться отжатие только двух клавиш. Если проверять исключительно KEYUP без последующей конкретизации, то отжатие любой клавиши приведет к остановке, даже если в это время будет по-прежнему зажиматься клавиша влево или вправо. Выражение i.key in [pygame.K_LEFT, pygame.K_RIGHT] обозначает, что если значение i.key совпадает с одним из значений в списке, то все выражение возвращает истину.

На самом деле существует способ по-проще. В библиотеке pygame с событиями работает не только модуль event. Так модуль pygame.key включает функции, связанные исключительно с клавиатурой. Здесь есть функция pygame.key.get_pressed(), которая возвращает кортеж двоичных значений. Индекс каждого значения соответствует своей клавиатурной константе. Само значение равно 1, если клавиша нажата, и 0 – если не нажата.

Эта функция подходит не для всех случаев обработки клавиатурных событий, но в нашем подойдет. Поэтому мы можем упростить код до такого варианта:

... 
while 1:
    sc.fill(WHITE)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    pygame.display.update()
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            exit()
 
    keys = pygame.key.get_pressed()
    if keys[pygame.K_LEFT]:
        x -= 3
    elif keys[pygame.K_RIGHT]:
        x += 3
 
    clock.tick(FPS)

Можно сказать, вызов get_pressed() снимает "маску" зажатых клавиш. Мы ее снимаем на каждой итерации главного цикла. Это даже не регистрация событий как таковых.

Выражение типа keys[pygame.K_LEFT] извлекает значение из кортежа по индексу, значение которого записано в константе K_LEFT. Если извлеченное значение True, то координата меняется.

Если необходимо, чтобы событие обрабатывалось при нажатии двух и более клавиш, то работает такое логическое выражение: keys[pygame.K_LEFT] and keys[pygame.K_a] (одновременное нажатие стрелки 'влево' и буквы 'a'). Однако если нужно задействовать не обычные клавиши, а модификаторы, то данный номер не проходит. По видимому в кортеже соответствующие модификаторам значения не хранятся.

В таком случае приходится возвращаться к первому варианту – перебирать события в цикле for:

... 
elif i.type == pygame.KEYDOWN:
    if i.key == pygame.K_LEFT and i.mod == pygame.KMOD_LSHIFT:
 
...

Здесь при if будет True, если перед нажатием стрелки был зажат левый Shift. Причем обратная последовательность: сначала зажать стрелку, потом Shift не сработает. Видимо модификаторы обрабатываются библиотекой pygame несколько отлично от обычных клавиш. Допустим, если при зажатии обычных клавиш генерируется только одно событие, то для модификаторов они генерируются постоянно или хранятся до отпускания в другой очереди.

Таким образом, если первым зажимается K_LEFT, то событие сразу обрабатывается. При этом в i.mod записывается отсутствие модификатора. Поэтому условие не срабатывает.

Если же первым зажимается модификатор, то это событие не теряется и позволяет условию при if выполнится в случае нажатия при этом обычной клавиши.

Весь перечень констант pygame, соответствующих клавишам клавиатуры, смотрите в документации: https://www.pygame.org/docs/ref/key.html

Практическая работа

Измените приведенную в уроке программу так, чтобы круг с той же скоростью, т. е. постепенно, возвращался назад в исходную точку, когда клавиша отпускается.

Курс с примерами решений практических работ: android-приложение, pdf-версия.

Комментарии

По видимому в кортеже соответствующие модификаторам значения не хранятся.
Весь набор клавиатуры содержится в pygame.key.get_pressed()
http://www.pygame.org/docs/ref/key.html

Ответ на от Евгений

Вариант с движением во все стороны и возврат в начальное состояние
Может быть кому-то будет интересно
import pygame
 
FPS = 60
W = 300  # ширина экрана
H = 300  # высота экрана
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
 
play = True # Переменная для включения главного цикла
motion = 'STOP' # Переменная для движения круга
 
_return = 0 # Триггер запуска возврата круга в начальные координаты
 
pygame.init()
sc = pygame.display.set_mode((W, H))
clock = pygame.time.Clock()
 
# координаты и радиус круга
x_start = W //2
y_start = H // 2
x = W // 2
y = H // 2
r = 10
 
while play:
    sc.fill(WHITE)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    pygame.display.update()
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            play = False
            pygame.quit()
            break
        elif i.type == pygame.KEYDOWN:
            _return = 0
            if i.key == pygame.K_LEFT:
                motion = 'LEFT'
            elif i.key == pygame.K_RIGHT:
                motion = 'RIGHT'
            elif i.key == pygame.K_UP:
                motion = 'UP'
            elif i.key == pygame.K_DOWN:
                motion = 'DOWN'
        elif i.type == pygame.KEYUP:
            if i.key in [pygame.K_LEFT, pygame.K_RIGHT, pygame.K_UP, pygame.K_DOWN]:
                motion = 'STOP'
                _return = 1
 
    # Движение круга
    if motion == 'LEFT':
        x -= 3
    elif motion == 'RIGHT':
        x += 3
    elif motion == 'UP':
        y -= 3
    elif motion == 'DOWN':
        y += 3
 
    # Возврат круга обратно
    if _return:
        if x_start < x:
            x -= 3
        elif x_start > x:
            x += 3
    if _return:
        if y_start < y:
            y -= 3
        elif y_start > y:
            y += 3
 
 
    clock.tick(FPS)

import pygame
 
FPS = 60
WIN_WIDTH = 640
WIN_HEIGHT = 480
 
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
 
pygame.init()
 
clock = pygame.time.Clock()
 
sc = pygame.display.set_mode((WIN_WIDTH, WIN_HEIGHT))
 
# радиус и координаты круга
r = 50
x = WIN_WIDTH // 2 	# выравнивание по центру 
y = WIN_HEIGHT // 2 
 
# положение круга
 
PLACE_L = 'левее центра'
PLACE_R = 'правее центра'
PLACE_C = 'в центре'
 
place = PLACE_C
 
back_move = False
 
while 1:
	sc.fill(WHITE)
 
	pygame.draw.circle(sc, BLUE, (x, y), r, 3)
 
	pygame.display.update()
 
	if x > (WIN_WIDTH // 2):
		place = PLACE_R
	elif x < (WIN_WIDTH // 2):
		place = PLACE_L
	else:
		place = PLACE_C
		back_move = False
 
 
	for i in pygame.event.get():
		if i.type == pygame.QUIT:
			exit()
		elif i.type == pygame.KEYUP:
			if i.key in [pygame.K_LEFT, pygame.K_RIGHT]:
				back_move = True
 
	keys = pygame.key.get_pressed()
	if keys[pygame.K_LEFT] and (x - r) > 0: # не уходить за границу окна
		x -= 3
	elif keys[pygame.K_RIGHT] and (x + r) < WIN_WIDTH:
		x += 3
 
	if back_move:
		if place == PLACE_R:
			x -= 3
		elif place == PLACE_L:
			x += 3
 
 
	clock.tick(FPS)

import pygame
 
# Variables and Constants
FPS = 60
WIN_WIDTH = 600
WIN_HEIGHT = 400
BLUE = (10, 50, 230)
ORANGE = (255, 150, 100)
BLACK = (0, 0 ,0)
 
pygame.init()
sc = pygame.display.set_mode((WIN_WIDTH, WIN_HEIGHT))
clock = pygame.time.Clock()
 
x = WIN_WIDTH // 2
y = WIN_HEIGHT // 2
r = 50
sy = 0
sx = 0
 
while True:
    sc.fill(BLACK)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            exit()
        elif i.type == pygame.KEYUP:
            if i.key == pygame.K_UP:
                sy = 3
            elif i.key == pygame.K_DOWN:
                sy = -3
            elif i.key == pygame.K_LEFT:
                sx = 3
            elif i.key == pygame.K_RIGHT:
                sx = -3
 
    y += sy
    x += sx
    if y == WIN_HEIGHT // 2:
        sy = 0
    if x == WIN_WIDTH // 2:
        sx = 0
 
    keys = pygame.key.get_pressed()
    if keys[pygame.K_LEFT] and x > 0 + r:
        x -= 6
    elif keys[pygame.K_RIGHT] and x < WIN_WIDTH - r:
        x += 6
    elif keys[pygame.K_UP] and y > 0 + r:
        y -= 6
    elif keys[pygame.K_DOWN] and y < WIN_HEIGHT - r:
        y += 6
 
    pygame.display.update()
 
    clock.tick(FPS)

Ответ на от Дмитрий

import pygame
 
FPS = 60
W = 700
H = 300
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
RIGHT = "to the right"
LEFT = "to the left"
STOP = "stop"
 
pygame.init()
sc = pygame.display.set_mode((W, H))
clock = pygame.time.Clock()
 
 
x = W // 2
y = H // 2
r = 50
 
motion = STOP
while 1:
    sc.fill(WHITE)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    pygame.display.update()
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            exit()
 
    keys = pygame.key.get_pressed()
    if keys[pygame.K_LEFT]:
        x -= 3
    elif keys[pygame.K_RIGHT]:
        x += 3
    elif (not(keys[pygame.K_LEFT]))and x<W//2:
        x+=3
    elif (not(keys[pygame.K_RIGHT]))and x>W//2:
        x-=3
    clock.tick(FPS)

Ответ на от Leeke

import pygame
 
FPS = 20
W = 700  # ширина экрана
H = 300  # высота экрана
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
speed = 4
 
pygame.init()
sc = pygame.display.set_mode((W, H))
clock = pygame.time.Clock()
 
# координаты и радиус круга
x = W // 2
y = H // 2
r = 50
 
while 1:
    sc.fill(WHITE)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    pygame.display.update()
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            exit()
 
    keys = pygame.key.get_pressed()
 
    if keys[pygame.K_LEFT]:
        x -= speed
    elif not (keys[pygame.K_LEFT]):
        if (x < W // 2):
            x += speed
 
    if (keys[pygame.K_RIGHT]):
        x += speed
    elif not (keys[pygame.K_RIGHT]):
        if (x > W // 2):
            x -= speed
 
    clock.tick(FPS)

import pygame
 
FPS = 60
W = 300  # ширина экрана
H = 300  # высота экрана
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
RIGHT = "to the right"
LEFT = "to the left"
STOP = "stop"
DOWN = "lower"
UP = "upper"
UPPER_LEFT = "upperleft"
 
pygame.init()
sc = pygame.display.set_mode((W, H))
clock = pygame.time.Clock()
 
# координаты и радиус круга
x = W // 2
y = H // 2
r = 20
 
motion = STOP
 
while 1:
    sc.fill(WHITE)
 
    pygame.draw.circle(sc, BLUE, (x, y), r)
 
    pygame.display.update()
 
    for i in pygame.event.get():
        if i.type == pygame.QUIT:
            exit()
 
    keys = pygame.key.get_pressed()
 
    if keys[pygame.K_UP] and keys[pygame.K_LEFT]:
        x -= 10
        y -= 10
    elif keys[pygame.K_UP] and keys[pygame.K_RIGHT]:
        x += 10
        y -= 10
    elif keys[pygame.K_DOWN] and keys[pygame.K_LEFT]:
        x -= 10
        y += 10
    elif keys[pygame.K_DOWN] and keys[pygame.K_RIGHT]:
        x += 10
        y += 10
    elif keys[pygame.K_LEFT]:
        x -= 10
    elif keys[pygame.K_RIGHT]:
        x += 10
    elif keys[pygame.K_UP]:
        y -= 10
    elif keys[pygame.K_DOWN]:
        y += 10
 
    if x < 0:
        x = 0
    if x > W:
        x = W
    if y < 0:
        y = 0
    if y > H:
        y = H
 
    clock.tick(FPS)

import pygame
 
FPS = 60
W = 700
H = 300
WHITE = (255, 255, 255)
BLUE = (0, 70, 225)
RIGHT = 'right'
LEFT = 'left'
STOP = "stop"
 
pygame.init()
sc = pygame.display.set_mode((W, H))
clock = pygame.time.Clock()
 
# координаты и радиус круга
x = W // 2
y = H // 2
r = 50
 
motion = STOP
 
while 1:
    sc.fill(WHITE)
    pygame.draw.circle(sc, BLUE, (x, y), r)
    pygame.display.update()
 
    for event in pygame.event.get():
        if event.type == pygame.QUIT:
            exit()
        # <Первый вариант...................................
    #     elif event.type == pygame.KEYDOWN:
    #         if event.key == pygame.K_LEFT:
    #             motion = LEFT
    #         elif event.key == pygame.K_RIGHT:
    #             motion = RIGHT
    #     elif event.type == pygame.KEYUP:
    #         if event.key in [pygame.K_LEFT, pygame.K_RIGHT]:
    #             motion = STOP
    #
    # if motion == LEFT:
    #     x -= 3
    # elif motion != LEFT and x < W // 2:
    #     x += 3
    # elif motion == RIGHT:
    #     x += 3
    # elif motion != RIGHT and x > W // 2:
    #     x -= 3
        # ...................................................>
    # <Второй вариант........................................
    keys = pygame.key.get_pressed()
    if keys[pygame.K_LEFT]:
        x -= 5
    elif not keys[pygame.K_LEFT] and x < W //2:
        x += 5
    elif keys[pygame.K_RIGHT]:
        x += 5
    elif not keys[pygame.K_RIGHT] and x > W //2:
        x -= 5
    # ...................................................>
    clock.tick(FPS)

Ответ на от Valerii

import pygame
 
 
SCREEN = (600, 400)
FPS = 60
BLUE = (0, 0, 255)
BLACK = (0, 0, 0)
 
 
STEP = 5
 
pygame.init()
 
sc = pygame.display.set_mode(SCREEN)
pygame.display.set_caption("MY SUPPERR PUPPERR GAME")
play = True
 
x = start_x = 250
y = 150
w = 100
h = 100
 
while play:
    sc.fill(BLACK)
    pygame.draw.rect(sc, BLUE, (x, y, w, h))
    pygame.display.update()
 
    for event in pygame.event.get():
        if event.type == pygame.QUIT:
            play = False
 
    keys = pygame.key.get_pressed()
    if keys[pygame.K_RIGHT]:
        x = x + STEP if x + w < SCREEN[0] else x
    elif keys[pygame.K_LEFT]:
        x = x - STEP if x > 0 else x
    elif not all([keys[pygame.K_RIGHT], keys[pygame.K_LEFT]]):
        if x < start_x:
            x += STEP
        elif x > start_x:
            x -= STEP
        else:
            pass
 
    pygame.time.Clock().tick(FPS)