WithinTilemapBoundsRule

Emits gated diagnostics when debug diagnostics are enabled

sort Weight: 10

Emits gated diagnostics when debug diagnostics are enabled

Version: v5.0.0

STABLE

Inherits: TileCheckRule
Source: within_tilemap_bounds_rule.gd
Parsing: AST-based for maximum accuracy with symbol typing

Constants

NON_CRITICAL_ISSUE_KEYWORDS:

Issue keywords considered non-critical for bounds checking (cosmetic/setup)

Methods

setup

Signature: setup(p_gts : GridTargetingState: Variant) -> Array

Returns: Array

Parameters:

  • p_gts : GridTargetingState: Variant

tear_down

Signature: tear_down() -> void

Correctly delegate to base PlacementRule.setup so _grid_targeting_state and _ready are initialized

Returns: void

validate_placement

Signature: validate_placement() -> RuleResult

For each tilemap indicator, check the tilemap to see if the tile at its position is used on any layer or not.

Returns: RuleResult

get_failing_indicators

Signature: get_failing_indicators(p_indicators : Array[RuleCheckIndicator]: Variant) -> Array

where the base implementation checks indicator.valid, but indicator.valid depends on rule results

Returns: Array

Parameters:

  • p_indicators : Array[RuleCheckIndicator]: Variant

_is_over_valid_tile

Signature: _is_over_valid_tile(p_indicator : RuleCheckIndicator: Variant, p_target_map : TileMapLayer: Variant) -> ValidationResults

p_target_map: Node2D - The target map to validate against

Returns: ValidationResults

Parameters:

  • p_indicator : RuleCheckIndicator: Variant
  • p_target_map : TileMapLayer: Variant

_filter_critical_indicator_issues

Signature: _filter_critical_indicator_issues(issues: Array[String]: Variant) -> Array

Filters indicator issues, returning only those considered critical for bounds checking

Returns: Array

Parameters:

  • issues: Array[String]: Variant

_is_critical_indicator_issue

Signature: _is_critical_indicator_issue(issue: String) -> bool

Determines if an issue string is critical (i.e., not cosmetic)

Returns: bool

Parameters:

  • issue: String

_debug_diagnostic

Signature: _debug_diagnostic(message: String) -> void

Emits gated diagnostics when debug diagnostics are enabled

Returns: void

Parameters:

  • message: String