Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.
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 ResourceMembers
| Name | Kind | Summary |
|---|---|---|
success_message | Property | Message to be passed along when the tile validates as successful |
expected_no_collisions_message | Property | Message to be passed along when the rule requirements were not met. |
expected_collision_message | Property | When collision is expected (physics overlap), this message will be added to failed results. |
expected_collisions_message | Property | |
no_indicators_message | Property | |
fail_blocked_message | Property | Player-friendly failure shown when placement is blocked by overlaps. [code]%d[/code]: number of indicators that detected a blocking overlap |
fail_missing_overlap_message | Property | Player-friendly failure shown when an overlap was required but missing. [code]%d[/code]: number of indicators that did not find a required overlap |
success_reason | Property | Player-friendly reason shown when collision validation succeeds |
failure_reason | Property | Player-friendly reason shown when collision validation fails |
no_indicators_reason | Property | Player-friendly reason shown when no indicators are available |
prepend_resource_name | Property | Add name of CollisionsCheckRule resource to the start of a fail / success message |
append_layer_names | Property | Whether to show a list of layers tested in output messages |
layers_tested_prefix | Property |
Source
addons/grid_placement/placement/placement_rules/resources/collision_rule_settings.gd
Plugin docs root:gdscript/plugins/grid_placement_dev/docs