CollisionRuleSettings
Summary
Section titled “Summary”Message configuration resource for CollisionsCheckRule. Provides modular, reusable message settings that can be shared across multiple rules.
Properties
Section titled “Properties”success_message:String
= “No placement collisions found”
- Message to be passed along when the tile validates as successful
expected_no_collisions_message:String
= “Must have no collisions”
- Message to be passed along when the rule requirements were not met.
expected_collision_message:String
= “Must have collisions in area”
When collision is expected (physics overlap), this message will be added to failed results.
expected_collisions_message:String
= “Must overlap “
no_indicators_message:String
= “No tile collision indicators to check for collisions in placement”
fail_blocked_message:String
= “Colliding on %d tile(s)”
Player-friendly failure shown when placement is blocked by overlaps.
%d: number of indicators that detected a blocking overlapfail_missing_overlap_message:String
= “Missing required overlap on %d tile(s)”
Player-friendly failure shown when an overlap was required but missing.
%d: number of indicators that did not find a required overlapsuccess_reason:String
= “Clear to build”
- Player-friendly reason shown when collision validation succeeds
failure_reason:String
= “Cannot build here”
- Player-friendly reason shown when collision validation fails
no_indicators_reason:String
= “No build area”
- Player-friendly reason shown when no indicators are available
prepend_resource_name:bool
Add name of CollisionsCheckRule resource to the start of a fail / success message
append_layer_names = false- Whether to show a list of layers tested in output messages
Source
Section titled “Source”addons/grid_building/placement/placement_rules/resources/collision_rule_settings.gd
This API reference is automatically generated from the plugin source code. For implementation examples and usage guides, see the guides section.