xiangqipy.terminal_output.TerminalStatusReporter Class Reference

Outputs a text-base game board with GamePiece locations in algebraic notation. More...

Inheritance diagram for xiangqipy.terminal_output.TerminalStatusReporter:

Collaboration diagram for xiangqipy.terminal_output.TerminalStatusReporter:

Public Member Functions
def	encode_piece (self, GamePiece piece)
def	format_board_output (self, GameBoard board)
def	display_player_info (self, PlayerSummary player_summary)
def	display_prev_move (self, PieceColor color, Move prev_move=None)
def	display_whose_turn (self, PieceColor color)
def	display_if_is_in_check (self, PieceColor color, bool is_in_check)
def	display_final_move (self, PieceColor color, Move final_move)
def	report_game_info (self, PlayerSummary red_player_summary, PlayerSummary black_player_summary, GameState game_state, GameBoard game_board, PieceColor whose_turn, bool is_in_check, int move_count, Move prev_move=None)
def	report_game_info (self, PlayerSummary red_player_summary, PlayerSummary black_player_summary, GameState game_state, bindings.GameBoard game_board, bindings.PieceColor whose_turn, bool is_in_check, int move_count, bindings.Move prev_move=None)

Static Public Member Functions
def	clear_screen ()
Dict[str, str]	move_evaluator_translator (PlayerSummary player_summary)
def	display_winner (GameState game_state)

Static Protected Attributes
dict	_disp_format
dict	_display_team_name = {PieceColor.kRed: "Red", PieceColor.kBlk: "Black"}
dict	_color_to_code
dict	_type_to_code

Detailed Description

Outputs a text-base game board with GamePiece locations in algebraic notation.

Definition at line 42 of file terminal_output.py.

Member Function Documentation

clear_screen()

def xiangqipy.terminal_output.TerminalStatusReporter.clear_screen ( )

static

Definition at line 74 of file terminal_output.py.

display_final_move()

def xiangqipy.terminal_output.TerminalStatusReporter.display_final_move	(		self,
		PieceColor	color,
		Move	final_move
	)

Definition at line 161 of file terminal_output.py.

display_if_is_in_check()

def xiangqipy.terminal_output.TerminalStatusReporter.display_if_is_in_check	(		self,
		PieceColor	color,
		bool	is_in_check
	)

Definition at line 157 of file terminal_output.py.

display_player_info()

def xiangqipy.terminal_output.TerminalStatusReporter.display_player_info	(		self,
		PlayerSummary	player_summary
	)

Definition at line 119 of file terminal_output.py.

display_prev_move()

def xiangqipy.terminal_output.TerminalStatusReporter.display_prev_move	(		self,
		PieceColor	color,
		Move	prev_move = None
	)

Definition at line 144 of file terminal_output.py.

display_whose_turn()

def xiangqipy.terminal_output.TerminalStatusReporter.display_whose_turn	(		self,
		PieceColor	color
	)

Definition at line 154 of file terminal_output.py.

display_winner()

def xiangqipy.terminal_output.TerminalStatusReporter.display_winner ( GameState  game_state )

static

Definition at line 169 of file terminal_output.py.

encode_piece()

def xiangqipy.terminal_output.TerminalStatusReporter.encode_piece	(		self,
		GamePiece	piece
	)

Definition at line 77 of file terminal_output.py.

format_board_output()

def xiangqipy.terminal_output.TerminalStatusReporter.format_board_output	(		self,
		GameBoard	board
	)

Definition at line 85 of file terminal_output.py.

move_evaluator_translator()

Dict[str, str] xiangqipy.terminal_output.TerminalStatusReporter.move_evaluator_translator ( PlayerSummary  player_summary )

static

Definition at line 107 of file terminal_output.py.

report_game_info()

def xiangqipy.terminal_output.TerminalStatusReporter.report_game_info	(		self,
		PlayerSummary	red_player_summary,
		PlayerSummary	black_player_summary,
		GameState	game_state,
		GameBoard	game_board,
		PieceColor	whose_turn,
		bool	is_in_check,
		int	move_count,
		Move	prev_move = None
	)

Reimplemented from xiangqipy.game_interfaces.MoveReporter.

Definition at line 177 of file terminal_output.py.

Member Data Documentation

_color_to_code

dict xiangqipy.terminal_output.TerminalStatusReporter._color_to_code

staticprotected

Initial value:

=  {
        PieceColor.kRed: "r",
        PieceColor.kBlk: "b",
        PieceColor.kNul: "-",
    }

Definition at line 56 of file terminal_output.py.

_disp_format

dict xiangqipy.terminal_output.TerminalStatusReporter._disp_format

staticprotected

Initial value:

=  {
        PieceColor.kRed: cr.Style.BRIGHT + cr.Fore.WHITE + cr.Back.RED,
        PieceColor.kBlk: cr.Style.BRIGHT + cr.Fore.BLACK + cr.Back.WHITE,
        PieceColor.kNul: cr.Fore.RESET + cr.Back.RESET,
    }

Definition at line 48 of file terminal_output.py.

_display_team_name

dict xiangqipy.terminal_output.TerminalStatusReporter._display_team_name = {PieceColor.kRed: "Red", PieceColor.kBlk: "Black"}

staticprotected

Definition at line 54 of file terminal_output.py.

_type_to_code

dict xiangqipy.terminal_output.TerminalStatusReporter._type_to_code

staticprotected

Initial value:

=  {
        PieceType.kCha: "R",
        PieceType.kHor: "H",
        PieceType.kEle: "E",
        PieceType.kAdv: "A",
        PieceType.kGen: "G",
        PieceType.kCan: "C",
        PieceType.kSol: "S",
        PieceType.kNnn: "-",
    }

Definition at line 62 of file terminal_output.py.

---

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

• src/xiangqipy/terminal_output.py