Skip to content

Class

CollisionsCheckRule

Generated GDScript class reference for GridPlacement.CollisionsCheckRule.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

Object rule: checks for physics collisions on each tile the object covers. By default the space must be clear. Turn on pass_on_collision to require an overlap instead.

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

Syntax

class CollisionsCheckRule extends TileCheckRule

Members

NameKindSummary
pass_on_collisionPropertyOff (default): the rule passes when nothing is in the way, as for normal buildings. On: the rule passes only when something is there, as for pieces that must attach to an existing structure.
collision_maskPropertyPhysics layers to check.
messagesPropertyMessages shown when the rule fails. Uses defaults when empty.
get_debug_identifierMethod
setupMethod
validate_placementMethod
validate_placement_fastMethod
get_failing_indicatorsMethod
get_editor_issuesMethod
get_runtime_issuesMethod