Grid Placement

WithinTilemapBoundsRule

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: placement/placement_rules/template_rules/within_tilemap_bounds_rule.gd

Version: 5.0

class_name: WithinTilemapBoundsRule extends: TileCheckRule

Signals

(none)

Exports

  • success_message
    • Failure message for out-of-bounds placement.
    • Optional: enable extra per-indicator diagnostics during tile lookups (very verbose)
    • Issue keywords considered non-critical for bounds checking (cosmetic/setup)
  • failed_message
    • Optional: enable extra per-indicator diagnostics during tile lookups (very verbose)
    • Issue keywords considered non-critical for bounds checking (cosmetic/setup)
  • no_indicators_message = “No tile collision indicators to check for within tilemap bounds.”
    • Optional: enable extra per-indicator diagnostics during tile lookups (very verbose)
    • Issue keywords considered non-critical for bounds checking (cosmetic/setup)
  • enable_debug_diagnostics: bool = false
    • Issue keywords considered non-critical for bounds checking (cosmetic/setup)

Methods

  • setup(p_gts: GridTargetingState) -> Array
    • Correctly delegate to base PlacementRule.setup so _grid_targeting_state and _ready are initialized
  • tear_down
    • Clear local state then delegate to base tear_down implementation
  • validate_placement -> RuleResult
  • get_failing_indicators(p_indicators: Array) -> Array
  • _is_over_valid_tile(p_indicator: RuleCheckIndicator, p_target_map: TileMapLayer) -> ValidationResults
  • _filter_critical_indicator_issues(issues: Array) -> Array
  • _is_critical_indicator_issue(issue: String) -> bool
  • _debug_diagnostic(message: String) -> void