Skip to content

Class

CollisionRuleSettings

Generated GDScript class reference for GridPlacement.CollisionRuleSettings.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

Message configuration resource for CollisionsCheckRule. Provides modular, reusable message settings that can be shared across multiple rules.

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

Syntax

class CollisionRuleSettings extends Resource

Members

NameKindSummary
success_messagePropertyMessage to be passed along when the tile validates as successful
expected_no_collisions_messagePropertyMessage to be passed along when the rule requirements were not met.
expected_collision_messagePropertyWhen collision is expected (physics overlap), this message will be added to failed results.
expected_collisions_messageProperty
no_indicators_messageProperty
fail_blocked_messagePropertyPlayer-friendly failure shown when placement is blocked by overlaps. [code]%d[/code]: number of indicators that detected a blocking overlap
fail_missing_overlap_messagePropertyPlayer-friendly failure shown when an overlap was required but missing. [code]%d[/code]: number of indicators that did not find a required overlap
success_reasonPropertyPlayer-friendly reason shown when collision validation succeeds
failure_reasonPropertyPlayer-friendly reason shown when collision validation fails
no_indicators_reasonPropertyPlayer-friendly reason shown when no indicators are available
prepend_resource_namePropertyAdd name of CollisionsCheckRule resource to the start of a fail / success message
append_layer_namesPropertyWhether to show a list of layers tested in output messages
layers_tested_prefixProperty