"""
pygame-menu
https://github.com/ppizarror/pygame-menu
CONTROLS
Default controls of Menu object and key definition.
"""
__all__ = [
# Joy pad
'JOY_AXIS_X',
'JOY_AXIS_Y',
'JOY_BUTTON_BACK',
'JOY_BUTTON_SELECT',
'JOY_DEADZONE',
'JOY_DELAY',
'JOY_DOWN',
'JOY_LEFT',
'JOY_REPEAT',
'JOY_RIGHT',
'JOY_UP',
# Keyboard events
'KEY_APPLY',
'KEY_BACK',
'KEY_CLOSE_MENU',
'KEY_LEFT',
'KEY_MOVE_DOWN',
'KEY_MOVE_UP',
'KEY_RIGHT',
# Controller object
'Controller'
]
# Imports
# noinspection PyUnresolvedReferences
import pygame_menu
import pygame.locals as _locals
from pygame.event import Event as EventType
from typing import Union
WidgetType = Union['pygame_menu.Menu', 'pygame_menu.widgets.Widget']
# Joy pad
JOY_AXIS_X = 0
JOY_AXIS_Y = 1
JOY_BUTTON_BACK = 1
JOY_BUTTON_SELECT = 0
JOY_DEADZONE = 0.5
JOY_DELAY = 300 # ms
JOY_DOWN = (0, -1)
JOY_LEFT = (-1, 0)
JOY_REPEAT = 100 # ms
JOY_RIGHT = (1, 0)
JOY_UP = (0, 1)
# Keyboard events
KEY_APPLY = _locals.K_RETURN
KEY_BACK = _locals.K_BACKSPACE
KEY_CLOSE_MENU = _locals.K_ESCAPE
KEY_LEFT = _locals.K_LEFT
KEY_MOVE_DOWN = _locals.K_UP
KEY_MOVE_UP = _locals.K_DOWN # Consider keys are "inverted"
KEY_RIGHT = _locals.K_RIGHT
KEY_TAB = _locals.K_TAB
# noinspection PyUnusedLocal
[docs]class Controller(object):
"""
Controller class. Accepts any object and provides functions to handle each
event.
"""
joy_delay: int
joy_repeat: int
def __init__(self) -> None:
self.joy_delay = JOY_DELAY
self.joy_repeat = JOY_REPEAT
[docs] @staticmethod
def apply(event: EventType, widget: WidgetType) -> bool:
"""
Accepts apply key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == KEY_APPLY
[docs] @staticmethod
def back(event: EventType, widget: WidgetType) -> bool:
"""
Accepts back key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == KEY_BACK
[docs] @staticmethod
def delete(event: EventType, widget: WidgetType) -> bool:
"""
Accepts delete key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == _locals.K_DELETE
[docs] @staticmethod
def end(event: EventType, widget: WidgetType) -> bool:
"""
Accepts end key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == _locals.K_END
[docs] @staticmethod
def escape(event: EventType, widget: WidgetType) -> bool:
"""
Accepts escape key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == _locals.K_ESCAPE
[docs] @staticmethod
def home(event: EventType, widget: WidgetType) -> bool:
"""
Accepts home key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == _locals.K_HOME
[docs] @staticmethod
def joy_axis_x_left(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement on x-axis (left direction). Requires ``pygame.JOYAXISMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.axis == JOY_AXIS_X and event.value < -JOY_DEADZONE
[docs] @staticmethod
def joy_axis_x_right(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement on x-axis (right direction). Requires ``pygame.JOYAXISMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.axis == JOY_AXIS_X and event.value > JOY_DEADZONE
[docs] @staticmethod
def joy_axis_y_down(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement on y-axis (down direction). Requires ``pygame.JOYAXISMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.axis == JOY_AXIS_Y and event.value > JOY_DEADZONE
[docs] @staticmethod
def joy_axis_y_up(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement on y-axis (up direction). Requires ``pygame.JOYAXISMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.axis == JOY_AXIS_Y and event.value < -JOY_DEADZONE
[docs] @staticmethod
def joy_back(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy back button. Requires ``pygame.JOYBUTTONDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.button == JOY_BUTTON_BACK
[docs] @staticmethod
def joy_down(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement to down direction. Requires ``pygame.JOYHATMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.value == JOY_DOWN
[docs] @staticmethod
def joy_left(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement to left direction. Requires ``pygame.JOYHATMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.value == JOY_LEFT
[docs] @staticmethod
def joy_right(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement to right direction. Requires ``pygame.JOYHATMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.value == JOY_RIGHT
[docs] @staticmethod
def joy_select(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy select button. Also used for apply(). Requires ``pygame.JOYBUTTONDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.button == JOY_BUTTON_SELECT
[docs] @staticmethod
def joy_up(event: EventType, widget: WidgetType) -> bool:
"""
Accepts joy movement to up direction. Requires ``pygame.JOYHATMOTION``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.value == JOY_UP
[docs] @staticmethod
def left(event: EventType, widget: WidgetType) -> bool:
"""
Accepts left key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == KEY_LEFT
[docs] @staticmethod
def move_down(event: EventType, widget: WidgetType) -> bool:
"""
Accepts move down key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == KEY_MOVE_DOWN
[docs] @staticmethod
def move_up(event: EventType, widget: WidgetType) -> bool:
"""
Accepts move up key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == KEY_MOVE_UP
[docs] @staticmethod
def right(event: EventType, widget: WidgetType) -> bool:
"""
Accepts right key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == KEY_RIGHT
[docs] @staticmethod
def tab(event: EventType, widget: WidgetType) -> bool:
"""
Accepts tab key. Requires ``pygame.KEYDOWN``.
:param event: Event
:param widget: Widget that accepts the event
:return: True if event matches
"""
return event.key == KEY_TAB