Skip to content

Class

CollisionRuleSettings

Generated GDScript class reference for GridPlacement.CollisionRuleSettings.

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.

Messages for a CollisionsCheckRule. One resource can be shared by several rules.

Source: addons/grid_placement/placement/placement_rules/resources/collision_rule_settings.gd

Syntax

class CollisionRuleSettings extends Resource

Members

NameKindSummary
success_messagePropertyShown in the action log when the rule passes and ActionLogSettings.print_success_reasons is on.
no_indicators_messagePropertyShown when the object has no collision shapes to check, so the rule fails.
fail_blocked_messagePropertyShown when something is in the way. %d is replaced with the number of blocked tiles.
fail_missing_overlap_messagePropertyShown when the rule needs an overlap and does not find one (see CollisionsCheckRule.pass_on_collision). %d is replaced with the number of tiles missing an overlap.
prepend_resource_namePropertyStarts each failure message with the rule's resource name. Useful while debugging.
append_layer_namesPropertyAdds the checked physics layers to each failure message. Useful while debugging.
layers_tested_prefixPropertyText shown before the list of checked layers.