Class TileCheckRule

Namespace

GridPlacement.GDScript

Assembly

MoonBark.GridPlacement.GDScript.dll

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

class TileCheckRule extends PlacementRule

TileCheckRule

Properties

apply_to_objects_mask

Physics layers for collision object detection.

@export_flags_2d_physics() var apply_to_objects_mask: int = 1

visual_priority

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.

@export_range(0, 10, 1, "or_greater") var visual_priority: int = 0

fail_visual_settings

Display settings for an indicator to use with an override priority.

@export var fail_visual_settings: IndicatorVisualSettings

indicators

List of all indicators that are currently using the rule for evaluation.

var indicators: Array[RuleCheckIndicator] = []

result

var result = validate_placement()

positions

var positions: Array[Vector2i] = []

target_map

var target_map: TileMapLayer = _grid_targeting_state.target_map

issues

var issues: Array[String] = []

issues

var issues: Array[String] = []

Methods

get_failing_indicators

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

Parameters

p_indicators

Returns

get_tile_positions

func get_tile_positions() -> Array[Vector2i]:

Returns

tear_down

func tear_down() -> void:

Returns

get_editor_issues

func get_editor_issues() -> Array[String]:

Returns

get_runtime_issues

func get_runtime_issues() -> Array[String]:

Returns