API

pyaudiogame.ui

pyaudiogame.ui
PyAudioGame's prebuilt interfaces.

description

pyaudiogame.ui provides classes to perform some of the more common tasks in game development such as creating menus, diologues and maps.

class pyaudiogame.Menu

Creates a class which can handle keyboard input to navigate a menu
Menu(options=["yes", "no"], default_position=0, keys={"back": "up", "forward": "down", "exit": ["escape", "backspace"], "except": "return"}, shortkeys=None, title="Test Menu", loops=True, persistent=0, sounds={})

• options
  a list of strings that the user sees. One of these will be returned from the run function.
• default_position
  The option number the menu will first start out on. All numbering starts from 0.
• keys
  Dict of keys for each action. Either a list of key names or a single key name is required. Not all keys need to be called.
  keys:
  *['back'] the key that is used to go up or left through a menu, default is "up"
  *['forward'] the key that is used to go down or right through a menu. Default is "down"
  *['exit'] The key that is used to get out of the menu. This returns "exit" from the run function. Default keys are "escape" and "backspace"
  *['except'] The key that will choose an option and returns it from the run function. Default key is "return"
• shortkeys
  *not working*
  If a list of keys is passed that is the same size as the options list, then when the user presses the key, they will jump to the corresponding item in options and return it.
• title
  The message that the user hears when the menu first opens.
• loops
  If set to true, when the user goes back from the first option, they will cycle to the last option. The same goes when the user is on the last option. If they go forward, they will go back to the first option again.
• persistent
  This argument determines when and if the player's position in the menu will be saved. There are 3 states:
  0 does not remember anything. The player will always go back to the default_position
  1 Is only remembered on exit. So if the user backs out of the menu and then returns, they will be in the same place as before. But if they hit except on that option, their position will go back to default_position
  2 remembers only on selection. So if the user backs out of the menu and goes back in, their position will be back at default_position. But if they hit except on an option, if they go back, their last selection will be the one selected.
  3 remembers both on exit and on except. So if the user exits the menu and comes back, they will be on their last position. If they hit except, they will land back on that option if they come back.
• sounds
  *not working*
  has 3 keys:
  *['change'] for when the back or forward keys are pressed
  *['exit'] for when the exit key is pressed
  *['except'] for when the except key is pressed

run

run(actions) -> choice
Will run the menu. It will return the option the user selects. Otherwise it will return None. If the user hits the exit key, "exit" will be returned. Pass it the actions dict from the logic function.
otherwise, the only key it pulls from the dict is ['key'].

class pyaudiogame.Typer

Creates a box which handles typing.
Typer(title="", valid_characters=['letters_simple', 'capitals', 'numbers', 'punctuation_simple'], multiline=False, length=0, current_string="")

• title
  The text that the user hears when the edit box opens. It is not editable by the user.
• valid_characters
  pass it a list of keys from the Typer.character_sets dict. Default sets are:
  *'numbers' numbers from 0-9
  *'letters_simple' no capital letters
  *'capitals' all capital letters
  *'punctuation_simple' .,-_'\"
  *punctuation_medium' \/[]=-`
  *note* not all the shifted punctuation work yet.
• multiline allows for users to hit "return" to get a newline character.
• length limits the length of the string. so if it was 5, the user could only type 5 characters. set it to 0 for no limit.
• current_string is default text that is typed in the edit box before the user enters anything.
  
  
  

run

run(actions) -> text string

This returns a text string when the user hits except.
pass in a dict with the "key" item in it. Prefferably the one from App.logic.

class pyaudiogame.Grid

Creates a grid, primarily for map creation.
Grid(width=50, height=50)

• width
  The width of the grid
• height
  The height of the grid

Note that what happens is that a grid object is created and it has info about stuff you put in that grid, like walls and whatnot.

check

check(x, y) -> bool
Run this to check if the point at (x, y) is in an object. If yes, this function returns True.

add_wall

add_wall(min_x=1, max_x=10, min_y=5, max_y=5) -> WallObject

• min_x, max_x
  The width of the wall.
• min_y, max_y
  the height of the wall.

*note*
a Wall consists of the length of the x Wall and the length of the y Wall. so if you draw a line from the min_x to the max_x, that is how wide the wall will be. If you do the same to the min_y and max_y lines, you will get the height of the wall.
So a wall that is 1,10 and 5,5, will be 10 squares long and 1 square high. A pretty clasic wall.