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

CollisionRule

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: rules/impl/collision_rule.gd

Version: 6.0

class_name: CollisionRule extends: PlacementRule

Signals

(none)

Exports

  • _flags_2d_physics
    • Controls collision validation behavior:
      • false: Rule PASSES when no collision (requires clear space)
      • true: Rule PASSES when collision detected (requires overlap)
    • Whether to check each tile individually or the whole bounding box.
    • Settings resource for message configuration
    • Debug mode for detailed collision information
    • Objects mask to apply collision check to
    • Visual priority for indicator display
    • Visual settings for failure state
  • pass_on_collision: bool = false
    • Whether to check each tile individually or the whole bounding box.
    • Settings resource for message configuration
    • Debug mode for detailed collision information
    • Objects mask to apply collision check to
    • Visual priority for indicator display
    • Visual settings for failure state
  • granular_check: bool = true
    • Settings resource for message configuration
    • Debug mode for detailed collision information
    • Objects mask to apply collision check to
    • Visual priority for indicator display
    • Visual settings for failure state
  • settings: CollisionRuleSettings
    • Debug mode for detailed collision information
    • Objects mask to apply collision check to
    • Visual priority for indicator display
  • debug_mode: bool = false
    • Objects mask to apply collision check to
    • Visual priority for indicator display
    • Visual settings for failure state
  • _flags_2d_physics
    • Controls collision validation behavior:
      • false: Rule PASSES when no collision (requires clear space)
      • true: Rule PASSES when collision detected (requires overlap)
    • Whether to check each tile individually or the whole bounding box.
    • Settings resource for message configuration
    • Debug mode for detailed collision information
    • Objects mask to apply collision check to
    • Visual priority for indicator display
    • Visual settings for failure state
  • visual_priority: int = 0
    • Visual settings for failure state
  • fail_visual_settings: CollisionRuleSettings

Methods

  • _init -> void
  • validate_rule_config -> Array
  • validate(context: PlacementRuleContext) -> ValidationResultComponent
  • _collect_rids_recursive(node: Node, out: Array) -> void