Skip to content

Class

RuleCheckIndicator2D

Generated GDScript class reference for GridPlacement.RuleCheckIndicator2D.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Tile indicator showing placement validity based on rules and collisions. Runs all assigned TileCheckRules and updates visuals for the building preview; used by IndicatorManager and PlacementValidator. Set TargetPosition to Vector2(0,0) so the indicator aligns with the tile under evaluation. [b]Isometric games:[/b] use [ConvexPolygonShape2D] with explicit diamond points, NOT a skewed [RectangleShape2D]. Under a rotated [ManipulationParent] the skew compounds into visual distortion; polygons rotate uniformly. See [code]project-architecture.md[/code] for building-flow docs.

Source: addons/grid_placement/placement/rule_check_indicator/rule_check_indicator_2d.gd

Syntax

class RuleCheckIndicator2D extends res://addons/grid_placement/base/placement_cached_shape_cast_2d.gd

Members

NameKindSummary
valid_changedSignalEmitted when validity status changes.
LogLevelField
validity_spritePropertySprite showing tile validity status.
show_indicatorsPropertyWhether to show the indicator sprites.
valid_settingsPropertyDisplay settings for a valid indicator; defaults at runtime, but production games should assign one.
invalid_settingsPropertyDisplay settings for an invalid indicator; defaults at runtime, but production games should assign one.
rulesPropertyRules checked for tile validity; all must pass. Production loads these through the PlacementSession; the @export is for editor debug only.
current_display_settingsProperty
validPropertyWhether the rules were validated for the area under the rule check indicator in the last test
resolve_placement_dependenciesMethod
get_rulesMethod
add_ruleMethod
get_tile_positionMethod
clearMethod
validate_rulesMethod
validate_runtimeMethod
trace_runtime_if_enabledMethod
get_runtime_issuesMethod
get_editor_issuesMethod
update_validity_stateMethod
force_validity_evaluationMethod
force_validity_evaluation_with_syncMethod