TileCheckRule
Summary
Section titled “Summary”Base class for rules that check tile properties for placement validation.
Properties
Section titled “Properties”fail_visual_settings: IndicatorVisualSettings
Display settings for an indicator to use with an override priority.
indicators: Array[RuleCheckIndicator] = []
List of all indicators that are currently using the rule for evaluation.
Methods
Section titled “Methods”func get_failing_indicators( p_indicators: Array[RuleCheckIndicator] ) -> Array[RuleCheckIndicator]
Runs the rule against an array of indicators Returns the indicators that fail the test
func 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
func tear_down( )
func get_editor_issues( ) -> Array[String]
Returns an array of issues found during editor validation
func get_runtime_issues( ) -> Array[String]
Returns an array of issues found during runtime validation
Source
Section titled “Source”addons/grid_building/placement/placement_rules/tile_check_rule.gd
This API reference is automatically generated from the plugin source code. For implementation examples and usage guides, see the guides section.