Grid Placement

CollisionRuleSettings

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: systems/placement/validators/placement_rules/resources/collision_rule_settings.gd

Version: 5.1

class_name: CollisionRuleSettings extends: Resource

Summary

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

Signals

(none)

Exports

  • success_message
    • Message to be passed along when the tile validates as successful
  • expected_no_collisions_message
    • Message to be passed along when the rule requirements were not met.
  • expected_collision_message
    • When collision is expected (physics overlap), this message will be added to failed results.
  • expected_collisions_message
  • fail_blocked_message
    • 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
    • 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
    • Player-friendly reason shown when collision validation succeeds
  • failure_reason
    • Player-friendly reason shown when collision validation fails
  • no_indicators_reason
    • Player-friendly reason shown when no indicators are available
  • prepend_resource_name
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
  • append_layer_names
    • Whether to show a list of layers tested in output messages
  • layers_tested_prefix

Methods

(none)