Class

CollisionsCheckRule

Generated GDScript class reference for GridPlacement.CollisionsCheckRule.

Status: Draft
Version: v6.0
Updated: Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Rule that validates placement based on collision detection. This rule checks for physics collisions at indicator positions and validates based on the [member pass_on_collision] setting: - [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")

Source: addons/grid_placement/placement/placement_rules/template_rules/collisions_check_rule.gd

Syntax

class CollisionsCheckRule extends TileCheckRule

Members

Name	Kind	Summary
`pass_on_collision`	Property	Controls collision validation behavior: - [code]false[/code]: Rule PASSES when no collision (placement requires clear space) - [code]true[/code]: Rule PASSES when collision detected (placement requires overlap) Common use cases: - [code]false[/code]: Building placement (needs empty space) - [code]true[/code]: Attachment mechanics (must connect to existing structures)
`collision_mask`	Property	Physics layers to scan for collisions.
`messages`	Property	Modular message configuration resource
`get_debug_identifier`	Method
`setup`	Method
`validate_placement`	Method
`get_failing_indicators`	Method
`get_editor_issues`	Method
`get_runtime_issues`	Method