get_paths_count¶

Summary¶

get_paths_count(squares: list[Square], prev_square_id: int, square_id: int, dice: int, limit: int)¶

This function calculates the number of paths on a square.

Parameters:

squares (list[Square]) – A list of Square objects to test.
prev_square_id (int) – The ID of the Previous Square, the one you previously walked over in-game. The one you have your back to.
square_id (int) – The ID of the Square for which to get the paths count.
dice (int) – The Maximum Dice Roll value of the board, which is used as the search depth in the calculation.
limit (int) – An upper limit of Max Paths to prevent computer slowdown.

Returns:

Returns the number of paths from that square.

Return type:

int

from cs_board_tools.validation.paths import get_paths_count