bridges.gamebase.GameBase Class Reference

Inheritance diagram for bridges.gamebase.GameBase:

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)
	PROTECTED constructor prevents the object from being directly created. More...
def	game_base_init (self, id, log, key, rows, cols)
	Initializes the gamebase object. More...
def	close (self)
	close the socket connection (and game) More...
def	register_keypress (self, kl)
def	start (self)
	"starts the game. Called once at the beginning" More...
def	initialize (self)
	"Game initialization. . Called once at the beginning" More...
def	game_loop (self)
	"Method contains all of the game logica and can call other user defined methods" More...
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
	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
	)

PROTECTED constructor prevents the object from being directly created.

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

Parameters

assid	assignment number
login	user name
apikey	authentication id
rows	height of game grid
cols	width of game grid

Returns

None

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

row	the row of the cell
col	the column of the cell
s	symbol
c	color

Returns

color of type NamedColor

game_base_init()

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

Initializes the gamebase object.

Parameters

id	assignment number
log	user name
key	authentication id
rows	height of game grid
cols	width 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

row	the row of the cell
col	the 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

row	the row of the cell
col	the 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

row	the row of the cell
col	the 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

row	the row of the cell
col	the column of the cell
color	color 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"

Member Data Documentation

bridges

bridges.gamebase.GameBase.bridges

debug

bool bridges.gamebase.GameBase.debug = True

static

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:

• /home/erik/work/bridges/bridges-python/bridges/gamebase.py