Bridges-Python  3.4.4
Bridges(Python API)
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
bridges.gamebase.GameBase Class Reference
Inheritance diagram for bridges.gamebase.GameBase:
bridges.blocking_game.BlockingGame bridges.non_blocking_game.NonBlockingGame

Detailed Description

This is the base class for all games in BRIDGES.

Author
David Burlinson, Erik Saule
Date
2020, 2021

Public Member Functions

def __init__ (self, assid, login, apikey, rows, cols, debug=False)
 PROTECTED constructor prevents the object from being directly created. More...
 
def game_base_init (self, id, log, key, rows, cols, debug=False)
 Initializes the gamebase object. More...
 
def close (self)
 close the socket connection (and game) More...
 
def register_keypress (self, kl)
 
def start (self)
 
def initialize (self)
 
def game_loop (self)
 
def quit (self)
 calling this function causes the game to end. More...
 
def set_title (self, title)
 sets title of game More...
 
def set_description (self, desc)
 sets description of the game More...
 
def get_bg_color (self, row, col)
 gets background color of a cell More...
 
def set_bg_color (self, row, col, color)
 sets background color of a cell More...
 
def get_symbol (self, row, col)
 gets symbol of the cell at row, col More...
 
def get_symbol_color (self, row, col)
 gets symbol color of the cell at row, col More...
 
def draw_symbol (self, row, col, s, c)
 draw symbol s with color col at cell (row, col) More...
 
def render (self)
 renders the board More...
 
def board_width (self)
 setter/getter property for board width More...
 
def board_height (self)
 setter/getter property for board height More...
 

Public Attributes

 grid_state
 
 debug
 
 firsttime
 
 bridges
 
 grid
 
 sock
 
 game_started
 

Static Public Attributes

bool debug = True
 

Constructor & Destructor Documentation

◆ __init__()

def bridges.gamebase.GameBase.__init__ (   self,
  assid,
  login,
  apikey,
  rows,
  cols,
  debug = False 
)

PROTECTED constructor prevents the object from being directly created.

Since GameBase is meant to be a purely internal class, that seems appropriate.

Parameters
assidassignment number
loginuser name
apikeyauthentication id
rowsheight of game grid
colswidth of game grid
Returns
None

Reimplemented in bridges.non_blocking_game.NonBlockingGame.

Member Function Documentation

◆ board_height()

def bridges.gamebase.GameBase.board_height (   self)

setter/getter property for board height

◆ board_width()

def bridges.gamebase.GameBase.board_width (   self)

setter/getter property for board width

◆ close()

def bridges.gamebase.GameBase.close (   self)

close the socket connection (and game)

◆ draw_symbol()

def bridges.gamebase.GameBase.draw_symbol (   self,
  row,
  col,
  s,
  c 
)

draw symbol s with color col at cell (row, col)

Parameters
rowthe row of the cell
colthe column of the cell
ssymbol
ccolor
Returns
color of type NamedColor

◆ game_base_init()

def bridges.gamebase.GameBase.game_base_init (   self,
  id,
  log,
  key,
  rows,
  cols,
  debug = False 
)

Initializes the gamebase object.

Parameters
idassignment number
loguser name
keyauthentication id
rowsheight of game grid
colswidth of game grid

◆ game_loop()

def bridges.gamebase.GameBase.game_loop (   self)
"Method contains all of the game logica and can call other user defined methods"

◆ get_bg_color()

def bridges.gamebase.GameBase.get_bg_color (   self,
  row,
  col 
)

gets background color of a cell

Parameters
rowthe row of the cell
colthe column of the cell
Returns
returns a NamedColor

◆ get_symbol()

def bridges.gamebase.GameBase.get_symbol (   self,
  row,
  col 
)

gets symbol of the cell at row, col

Parameters
rowthe row of the cell
colthe column of the cell
Returns
Symbol of type NamedSymbol

◆ get_symbol_color()

def bridges.gamebase.GameBase.get_symbol_color (   self,
  row,
  col 
)

gets symbol color of the cell at row, col

Parameters
rowthe row of the cell
colthe column of the cell
Returns
color of type NamedColor

◆ initialize()

def bridges.gamebase.GameBase.initialize (   self)
"Game initialization. . Called once at the beginning"

◆ quit()

def bridges.gamebase.GameBase.quit (   self)

calling this function causes the game to end.

Returns
None

◆ register_keypress()

def bridges.gamebase.GameBase.register_keypress (   self,
  kl 
)

◆ render()

def bridges.gamebase.GameBase.render (   self)

renders the board

◆ set_bg_color()

def bridges.gamebase.GameBase.set_bg_color (   self,
  row,
  col,
  color 
)

sets background color of a cell

Parameters
rowthe row of the cell
colthe column of the cell
colorcolor to be set
Returns
None

◆ set_description()

def bridges.gamebase.GameBase.set_description (   self,
  desc 
)

sets description of the game

Returns
None

◆ set_title()

def bridges.gamebase.GameBase.set_title (   self,
  title 
)

sets title of game

Returns
None

◆ start()

def bridges.gamebase.GameBase.start (   self)
"starts the game. Called once at the beginning"

Reimplemented in bridges.non_blocking_game.NonBlockingGame, and bridges.blocking_game.BlockingGame.

Member Data Documentation

◆ bridges

bridges.gamebase.GameBase.bridges

◆ debug [1/2]

bool bridges.gamebase.GameBase.debug = True
static

◆ debug [2/2]

bridges.gamebase.GameBase.debug

◆ firsttime

bridges.gamebase.GameBase.firsttime

◆ game_started

bridges.gamebase.GameBase.game_started

◆ grid

bridges.gamebase.GameBase.grid

◆ grid_state

bridges.gamebase.GameBase.grid_state

◆ sock

bridges.gamebase.GameBase.sock

The documentation for this class was generated from the following file: