Chris' Tutorials
Docs/Grid Placement

Class

TileCheckRule

Generated GDScript class reference for GridPlacement.TileCheckRule.

StatusDraft
Versionv6.0
UpdatedDevelopment docs generated from GDScript source

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

Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.

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

Source: addons/grid_placement/placement/placement_rules/tile_check_rule.gd

Syntax

class TileCheckRule extends PlacementRule

Members

NameKindSummary
get_supported_actionsMethod
apply_to_objects_maskPropertyPhysics layers for collision object detection.
visual_priorityPropertyPriority 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.
fail_visual_settingsPropertyDisplay settings for an indicator to use with an override priority.
indicatorsPropertyList of all indicators that are currently using the rule for evaluation.
get_failing_indicatorsMethod
resultProperty
get_tile_positionsMethod
positionsProperty
target_mapProperty
tear_downMethod
get_editor_issuesMethod
issuesProperty
get_runtime_issuesMethod
issuesProperty

Source

addons/grid_placement/placement/placement_rules/tile_check_rule.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs