Grid Placement
Development ⚠️ GridPlacement 6.0 (GECS) is in active development. This is the GDScript ECS architecture.

PlacementRule

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: rules/placement_rule.gd

Version: 6.0

class_name: PlacementRule extends: Resource

Signals

(none)

Exports

  • priority: int = 0
    • Whether this rule is currently active
    • Rule identifier for debugging and configuration
    • Rule description for documentation
    • Validates placement using the provided context
    • [param context]: PlacementRuleContext containing all validation data
    • [return]: ValidationResultComponent with validation outcome
  • is_active: bool = true
    • Rule identifier for debugging and configuration
    • Rule description for documentation
    • Validates placement using the provided context
    • [param context]: PlacementRuleContext containing all validation data
    • [return]: ValidationResultComponent with validation outcome
  • rule_id: StringName = ""
    • Rule description for documentation
    • Validates placement using the provided context
    • [param context]: PlacementRuleContext containing all validation data
    • [return]: ValidationResultComponent with validation outcome
  • description: String = ""
    • Validates placement using the provided context
    • [param context]: PlacementRuleContext containing all validation data
    • [return]: ValidationResultComponent with validation outcome

Methods

  • validate(context: PlacementRuleContext) -> ValidationResultComponent
  • validate_rule_config -> Array
  • get_debug_string -> String
  • should_execute(context: PlacementRuleContext) -> bool
  • before_validate(context: PlacementRuleContext) -> void
  • after_validate(context: PlacementRuleContext, result: ValidationResultComponent) -> void
  • duplicate_rule -> PlacementRule
  • _to_string -> String