TileCheckRule

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

Base class for rules that check tile properties for placement validation.

Source File: addons/grid_building/placement/placement_rules/tile_check_rule.gd

Extends: PlacementRule

Exported Properties

  • Property: fail_visual_settings : [IndicatorVisualSettings](./indicator-visual-settings/) - Display settings for an indicator to use with an override priority.

Properties

  • Property: apply_to_objects_mask : int = 1 - Physics layers for collision object detection.

  • Property: visual_priority : int = 0

    Priority for handling multiple rule failures. Rule with the highest priority and a fail display settings set will be used in the indicator’s sprite to display.

  • Property: indicators : Array[RuleCheckIndicator] = [] - List of all indicators that are currently using the rule for evaluation.

Public Methods

get_failing_indicators

1
2
3

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

Runs the rule against an array of indicators Returns the indicators that fail the test

get_tile_positions

1

get_tile_positions() -> Array[Vector2i]

Returns the tile locations that the indicators are currently positioned over on the tilemap You can call this after the rules have been setup for the object being manipulated

tear_down

1

tear_down()

get_editor_issues

1

get_editor_issues() -> Array[String]

Returns an array of issues found during editor validation

get_runtime_issues

1

get_runtime_issues() -> Array[String]

Returns an array of issues found during runtime validation