Skip to content

Class

RuleCheckIndicator2D

Generated GDScript class reference for GridPlacement.RuleCheckIndicator2D.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

Marks one tile under the placement preview as valid or invalid. Indicators are created from the scene in PlacementTemplates.rule_check_indicator, one per covered tile. Set the shape cast's ShapeCast2D.target_position to Vector2(0, 0) so the indicator lines up with its tile. Isometric games: use a ConvexPolygonShape2D with diamond points, not a skewed RectangleShape2D. A skewed rectangle distorts when the preview is rotated; a polygon rotates cleanly.

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 valid changes.
LogLevelField
validity_spritePropertySprite that shows the valid or invalid look.
show_indicatorsPropertyWhether the indicator is visible.
valid_settingsPropertyLook of the indicator when the tile is valid. A default is used when empty, but you should assign one.
invalid_settingsPropertyLook of the indicator when the tile is invalid. A default is used when empty, but you should assign one.
rulesPropertyRules checked for this tile; all must pass. Set automatically during placement. Exported only for inspecting in the editor.
current_display_settingsProperty
validPropertyWhether the tile passed every rule in the last check.
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