Skip to content

Class

WithinTilemapBoundsRule

Generated GDScript class reference for GridPlacement.WithinTilemapBoundsRule.

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 a tile on the target map, so objects cannot be placed off the edge of the map. 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/within_tilemap_bounds_rule.gd

Syntax

class WithinTilemapBoundsRule extends TileCheckRule

Members

NameKindSummary
success_messagePropertyShown in the action log when the rule passes and ActionLogSettings.print_success_reasons is on.
failed_messagePropertyShown when part of the object is off the map.
no_indicators_messagePropertyShown when the object has no collision shapes, so there are no tiles to check.
enable_debug_diagnosticsPropertyLogs details for every tile checked. Very verbose; for debugging only.
NON_CRITICAL_ISSUE_KEYWORDSFieldIssue keywords considered non-critical for bounds checking (cosmetic/setup)
setupMethod
tear_downMethod
validate_placement_fastMethod
validate_placementMethod
get_failing_indicatorsMethod