Grid Placement
Development ⚠️ GridPlacement 6.0 (GECS) is in active development. This is the GDScript ECS architecture.

ValidPlacementTileRuleSettings

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: rules/settings/valid_placement_tile_rule_settings.gd

Version: 6.0

class_name: ValidPlacementTileRuleSettings extends: Resource

Signals

(none)

Exports

  • _group
    • Success message for valid tiles
    • Player-friendly reason shown when tile validation succeeds
    • Message to be passed along when the rule requirements were not met
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • success_message: String = “All expected nearby tiles exist”
    • Player-friendly reason shown when tile validation succeeds
    • Message to be passed along when the rule requirements were not met
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • success_reason: String = “Valid placement”
    • Message to be passed along when the rule requirements were not met
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • _group
    • Success message for valid tiles
    • Player-friendly reason shown when tile validation succeeds
    • Message to be passed along when the rule requirements were not met
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • failed_message: String = “Tiles in expected tile areas are missing”
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • failure_reason: String = “Invalid location”
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • _group
    • Success message for valid tiles
    • Player-friendly reason shown when tile validation succeeds
    • Message to be passed along when the rule requirements were not met
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • no_indicators_message: String = “No tile collision indicators to check for valid tile placement”
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • no_indicators_reason: String = “No build area”
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • _group
    • Success message for valid tiles
    • Player-friendly reason shown when tile validation succeeds
    • Message to be passed along when the rule requirements were not met
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • prepend_resource_name: bool = false
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • show_tile_details: bool = false
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • show_failing_coordinates: bool = false
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • _group
    • Success message for valid tiles
    • Player-friendly reason shown when tile validation succeeds
    • Message to be passed along when the rule requirements were not met
    • Player-friendly reason shown when tile validation fails
    • Message to output when there are no tile collision indicators to check against the rule
    • Player-friendly reason shown when no indicators are available
    • Add name of ValidPlacementTileRule resource to the start of a fail / success message
    • Show detailed tile data information in failure messages
    • Show coordinates of failing tiles in messages
    • Enable detailed tile validation debugging
    • Log all tile data checks during validation
    • Validate settings configuration
  • debug_mode: bool = false
    • Log all tile data checks during validation
    • Validate settings configuration
  • log_tile_checks: bool = false
    • Validate settings configuration

Methods

  • validate -> Array
  • get_formatted_failed_message(count: int) -> String
  • get_success_message(resource_name: String = "") -> String
  • get_failure_message(resource_name: String = "") -> String
  • get_detailed_failure_message(failing_positions: Array, resource_name: String = "") -> String
  • get_summary -> Dictionary