Skip to content

Class

CollisionsCheckRule

Generated GDScript class reference for GridPlacement.CollisionsCheckRule.

Status
Current
Version
v6.2.1
Source updated
2026-09-24
Generated on
2026-10-22

Rule that validates placement based on collision detection. This rule checks for physics collisions at indicator positions and validates based on the pass_on_collision setting: - false (default): Placement FAILS if collision detected ("must have clear space") - true: 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

NameKindSummary
pass_on_collisionPropertyControls collision validation behavior: - false: Rule PASSES when no collision (placement requires clear space) - true: Rule PASSES when collision detected (placement requires overlap) Common use cases: - false: Building placement (needs empty space) - true: Attachment mechanics (must connect to existing structures)
collision_maskPropertyPhysics layers to scan for collisions.
messagesPropertyModular message configuration resource
get_debug_identifierMethod
setupMethod
validate_placementMethod
validate_placement_fastMethod
get_failing_indicatorsMethod
get_editor_issuesMethod
get_runtime_issuesMethod