Skip to index filter Skip to main content
cs-board-toolscs-board-tools
Search the documentation

cs-board-tools

  • fortunestreetmodding/cs-board-tools

  • Change appearance
    • Change appearance
    • Light
    • Dark
    • Automatic
  Index
Index
  • Home
  • Getting Started
  • Usage
  • API Reference
    • cs_board_tools
      • cli
        • bundle
          • print_bundles
          • print_bundles_validation_result
        • descriptor
          • print_descriptors
          • print_descriptors_validation_result
        • frb
          • print_frbs
          • print_frbs_validation_result
      • errors
        • get_count
        • get_text
        • process_log_messages
        • reset_errors_and_warnings
        • IssueType
      • io
        • bundle
          • cleanup_filenames
          • read_files
          • read_zip
        • frb
          • read_frb
          • write_frb
        • yaml
          • read_yaml
          • read_yaml_schema
      • queries
        • frb
          • squaretype
            • are_square_types_present
            • is_square_type_present
      • schema
        • analysis
          • SquareAnalysis
        • bundle
          • Bundle
          • Filenames
        • descriptor
          • build_map_descriptor_object
          • AuthorInfo
          • ChangeLogEntry
          • CustomMusic
          • Description
          • DistrictNames
          • LoopingInfo
          • MapDescriptor
          • Name
          • ShopNames
          • SwitchRotationOriginPoints
          • TourModeInfo
          • VentureCardInfo
        • frb
          • read_frb
          • write_frb
          • BoardData
          • BoardFile
          • BoardInfo
          • Header
          • LoopingMode
          • MagicNumber
          • Square
          • SquareType
          • WaypointData
        • validation
          • CheckResult
          • ValidationResult
          • ValidationResultBundle
      • utilities
        • collections
          • remove_null_entries_from_dict
        • filesystem
          • cleanup
          • get_files_recursively
          • remove_temp_directories
          • remove_temp_files
        • yaml
          • load_yaml
          • load_yaml_schema
        • zip
          • extract_zip_file
      • validation
        • board
          • check_board_configuration
          • check_doors_and_dice
          • check_square_coordinates
          • check_switch_ids_are_not_too_high
          • check_switch_ids_are_not_zero
          • check_two_way_doors
          • check_yaml_authors
          • check_yaml_changelog
          • check_yaml_max_dice_roll
        • consistency
          • check_consistency
          • compare_values
          • convert_galaxy_status
        • filesystem
          • check_for_screenshots
          • check_icon
        • main
          • validate_board_file
          • validate_bundle
          • validate_descriptor
        • music
          • check_music_download
          • handle_file_size_error
          • MusicFileMetadata
        • naming
          • check_naming_convention
          • file_exists
          • filename_capitalization_matches
          • filename_contains_spaces
        • network
          • get_file_metadata
          • FileMetadata
        • paths
          • calculate_max_paths
          • check_max_paths
          • get_destinations
          • get_paths_count
          • get_paths_count_without_prev_square
        • results
          • build_results_object
        • venture
          • check_card_115
          • check_card_125
          • check_card_45
          • check_card_87
          • check_venture_cards
  1. Start
  2. API Reference
  3. cs_board_tools
  4. schema
  5. analysis

analysisΒΆ

Classes that hold query results or other useful groupings of data go here.

Classes

SquareAnalysis

Represents the SquareTypes present on the board in question and how many of each type there are.

  On this page
  • analysis
  • Previous schema
  • Next SquareAnalysis
  • Home
  • Repository
  • Issues
  • Discord
cs-board-tools
  • 2023-2024, Custom Street
Built with Sphinx 9.1.0 and Nefertiti 0.9.8