controller.py

import pygame

class Controller:
    """Handle user input and translate to a useable format.

    The class holds functions useful for retrieving user input and varables
    describing the state of monitored user inputs.

    Class variables:
    ping_keys - A dictionary of boolians monitoring the inputs used for pinging
        the user's environment. True means the user is supplying an input in the
        given direction.
    move_keys - A dictionary of boolians monitoring the inputs used for moving
        the user around their environment. True means the user is supplying an
        input in the given direction.
    move_keys - A dictionary of boolians monitoring the inputs used for
        accessing the user's inventory. True means the user is supplying an
        input for the given inventory slot.
    """

    def __init__(self):
        """Initalize the Controller class with default variable values"""

        #variables to store the states of the controll keys
        #values are true while the key is pressed and false when the key is not
        self.ping_keys = {'front':False,'back':False,'left':False,'right':False}
        self.move_keys = {'north':False,'south':False,'west':False,'east':False}
        self.interact_key = False
        self.hs_keys = {'space':False,'I':False,'C':False,'H':False}

    def read_input(self):
        """Read the inputs to the game

        The function will read inputs from the keyboard and will update the
        controller's variables of ping_keys, move_keys, and inventory_keys to
        reflect the current status of the monitored keys on the keyboard.

        Keyword arguments: None
        Return values: None
        """


        #get which keys are pressed
        pressed_keys = pygame.key.get_pressed()

        #update home screen move_keys
        self.hs_keys['space'] = pressed_keys[pygame.K_SPACE]
        self.hs_keys['I'] = pressed_keys[pygame.K_i]
        self.hs_keys['C'] = pressed_keys[pygame.K_c]
        self.hs_keys['H'] = pressed_keys[pygame.K_h]

        #update the values of the ping controlling keys
        self.ping_keys['front'] = pressed_keys[pygame.K_UP]
        self.ping_keys['back'] = pressed_keys[pygame.K_DOWN]
        self.ping_keys['left'] = pressed_keys[pygame.K_LEFT]
        self.ping_keys['right'] = pressed_keys[pygame.K_RIGHT]

        #update the values of the movment controlling keys
        self.move_keys['north'] = pressed_keys[pygame.K_w]
        self.move_keys['south'] = pressed_keys[pygame.K_s]
        self.move_keys['west'] = pressed_keys[pygame.K_a]
        self.move_keys['east'] = pressed_keys[pygame.K_d]

        #update the values of the inventory slot controlling keys
        self.interact_key = pressed_keys[pygame.K_e]