Grid Placement

CollisionsCheckRule

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: placement/placement_rules/template_rules/collisions_check_rule.gd

Version: 5.0

class_name: CollisionsCheckRule extends: TileCheckRule

Signals

(none)

Exports

  • pass_on_collision = false
      • [code]false[/code] (default): Placement FAILS if collision detected (“must have clear space”)
      • [code]true[/code]: Placement FAILS if NO collision detected (“must overlap with existing objects”)
  • _flags_2d_physics
    • Modular message configuration resource
  • messages
    • Setup the rule with the provided GridTargetingState.
    • Returns an array of issues found during setup.
    • [code]p_gts[/code]: [i]GridTargetingState[/i] - The targeting state to use for placement
    • [returns] Array[String] - Array of issues found during setup

Methods

  • _init
  • setup(p_gts: GridTargetingState) -> Array
  • validate_placement -> RuleResult
  • get_failing_indicators(p_indicators: Array) -> Array
    • Perform collision checks
  • _indicator_apply_target_exceptions(indicator: ShapeCast2D) -> void
  • _collect_bodies_recursive(node: Node, out: Array) -> void
  • get_editor_issues -> Array
  • get_runtime_issues -> Array