Grid Placement

CollisionRuleSettings

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: placement/placement_rules/resources/collision_rule_settings.gd

Version: 5.0

class_name: CollisionRuleSettings extends: Resource

Signals

(none)

Exports

  • _group
    • Message to be passed along when the tile validates as successful
    • Message to be passed along when the rule requirements were not met.
    • When collision is expected (physics overlap), this message will be added to failed results.
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • success_message
    • Message to be passed along when the rule requirements were not met.
    • When collision is expected (physics overlap), this message will be added to failed results.
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • expected_no_collisions_message
    • When collision is expected (physics overlap), this message will be added to failed results.
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • expected_collision_message
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • expected_collisions_message
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • no_indicators_message
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • fail_blocked_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
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • fail_missing_overlap_message
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • _group
    • Message to be passed along when the tile validates as successful
    • Message to be passed along when the rule requirements were not met.
    • When collision is expected (physics overlap), this message will be added to failed results.
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • success_reason
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • failure_reason
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • no_indicators_reason
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • _group
    • Message to be passed along when the tile validates as successful
    • Message to be passed along when the rule requirements were not met.
    • When collision is expected (physics overlap), this message will be added to failed results.
    • Player-friendly failure shown when placement is blocked by overlaps.
    • [code]%d[/code]: number of indicators that detected a blocking overlap
    • Player-friendly failure shown when an overlap was required but missing.
    • [code]%d[/code]: number of indicators that did not find a required overlap
    • Player-friendly reason shown when collision validation succeeds
    • Player-friendly reason shown when collision validation fails
    • Player-friendly reason shown when no indicators are available
    • Add name of CollisionsCheckRule resource to the start of a fail / success message
    • Whether to show a list of layers tested in output messages
  • prepend_resource_name
    • Whether to show a list of layers tested in output messages
  • append_layer_names = false
  • layers_tested_prefix

Methods

(none)