check_max_paths¶
Summary¶
- check_max_paths(frb: BoardFile, skip: bool = False, skip_warnings: bool = False) CheckResult¶
Checks the Max Paths values for all squares on a board, and warns if the values are too high.
This warns, rather than erroring, because although a high max paths value is likely to indicate that a game played on this board will crash, it doe not necessarily indicate that. There are boards with values as high as 220 that work totally fine. Yet another with a value of 135 might crash.
- Parameters:
frb (BoardFile) – A BoardFile object representing an .frb file.
skip (bool) – If set to True, the check will be skipped, but a valid resultobject with no messages and SKIPPED as its status will still be returned.
skip_warnings (bool, optional) – If set, skips tests resulting in “Warning” messages.
- Returns:
A CheckResult object containing the check status as well as any messages and additional data.
- Return type:
Importing¶
from cs_board_tools.validation.paths import check_max_paths