Skip to content

Class

ValidPlacementTileRule

Generated GDScript class reference for GridPlacement.ValidPlacementTileRule.

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.

Object rule: every tile under the object must have the right TileSet custom data. Use it to allow building only on certain ground, such as "buildable" tiles. Set expected_tile_custom_data to the custom data names and values each tile must have, for example { "type": "ground", "variant": "grass" }. Add the rule to GridPlacementSettings.placement_rules for every object, or to an entry's own rules.

Source: addons/grid_placement/placement/placement_rules/template_rules/valid_placement_tile_rule.gd

Syntax

class ValidPlacementTileRule extends TileCheckRule

Members

NameKindSummary
expected_tile_custom_dataPropertyCustom data names and the values each tile must have.
settingsPropertyMessages shown when the rule fails. Uses defaults when empty.
setupMethod
validate_placementMethod
tear_downMethod
does_tile_have_valid_dataMethod