Skip to content

Class

AdjacentToCategoryRule

Generated GDScript class reference for GridPlacement.AdjacentToCategoryRule.

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: the object must be placed next to an object that has required_profile. Example: a fence piece with a "Fence" profile must be placed next to another fence.

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

Syntax

class AdjacentToCategoryRule extends TileCheckRule

Members

NameKindSummary
required_profilePropertyProfile a neighboring object must have.
min_neighborsPropertyFewest neighboring cells that must hold a matching object.
include_diagonalPropertyWhen on, diagonal neighbors also count.
error_messagePropertyMessage shown when the rule fails.
validate_placementMethod