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

CollisionRuleSettings

AUTO-GENERATED (GDScript) API entry

February 13, 2026

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: rules/settings/collision_rule_settings.gd

Version: 6.0

class_name: CollisionRuleSettings extends: Resource

Signals

(none)

Exports

  • _group
    • Message to be passed along when the tile validates as successful
    • Player-friendly reason shown when collision validation succeeds
    • Message to be passed along when the rule requirements were not met
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • success_message: String = “No placement collisions found”
    • Player-friendly reason shown when collision validation succeeds
    • Message to be passed along when the rule requirements were not met
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • success_reason: String = “Clear to build”
    • Message to be passed along when the rule requirements were not met
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • _group
    • Message to be passed along when the tile validates as successful
    • Player-friendly reason shown when collision validation succeeds
    • Message to be passed along when the rule requirements were not met
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • expected_no_collisions_message: String = “Must have no collisions”
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • expected_collision_message: String = “Must have collisions in area”
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • fail_blocked_message: String = “Colliding on %d tile(s)”
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • fail_missing_overlap_message: String = “Missing required overlap on %d tile(s)”
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • failure_reason: String = “Cannot build here”
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • _group
    • Message to be passed along when the tile validates as successful
    • Player-friendly reason shown when collision validation succeeds
    • Message to be passed along when the rule requirements were not met
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • no_indicators_message: String = “No tile collision indicators to check for collisions in placement”
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • no_indicators_reason: String = “No build area”
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • _group
    • Message to be passed along when the tile validates as successful
    • Player-friendly reason shown when collision validation succeeds
    • Message to be passed along when the rule requirements were not met
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • prepend_resource_name: bool = false
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • append_layer_names: bool = false
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • layers_tested_prefix: String = “Layers Checked: "
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • _group
    • Message to be passed along when the tile validates as successful
    • Player-friendly reason shown when collision validation succeeds
    • Message to be passed along when the rule requirements were not met
    • When collision is expected (physics overlap), this message will be added to failed results
    • Player-friendly failure shown when placement is blocked by overlaps
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation fails
    • Message when no tile collision indicators are available
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
    • Prefix for layer names when displayed
    • Enable detailed collision debugging information
    • Show individual indicator collision states
    • Validate settings configuration
  • debug_mode: bool = false
    • Show individual indicator collision states
    • Validate settings configuration
  • show_indicator_details: bool = false
    • Validate settings configuration

Methods

  • validate -> Array
  • get_formatted_blocked_message(count: int) -> String
  • get_formatted_missing_overlap_message(count: int) -> String
  • get_success_message(resource_name: String = "") -> String
  • get_failure_message(resource_name: String = "") -> String
  • get_summary -> Dictionary