Skip to content
Grid Building Docs

WithinTilemapBoundsRule

Summary

Section titled “Summary”

Rule that validates placement is within tilemap boundaries.

Properties

Section titled “Properties”
success_message: String = “Placement is within map bounds”

Success message for valid placement.

failed_message: String = “Tried placing outside of valid map area”

Failure message for out-of-bounds placement.

no_indicators_message = “No tile collision indicators to check for within tilemap bounds.”
enable_debug_diagnostics: bool = false

Optional: enable extra per-indicator diagnostics during tile lookups (very verbose)

success_reason: String = “Good location”

Player-friendly reason shown when bounds validation succeeds

failure_reason: String = “Too far out”

Player-friendly reason shown when bounds validation fails

no_indicators_reason: String = “No build area”

Player-friendly reason shown when no indicators are available

Methods

Section titled “Methods”
setup( p_gts: GridTargetingState ) -> Array[String]
tear_down( )
validate_placement( ) -> RuleResult

For each tilemap indicator, check the tilemap to see if the tile at its position is used on any layer or not.

Source

Section titled “Source”

addons/grid_building/placement/placement_rules/template_rules/within_tilemap_bounds_rule.gd

This page was auto-generated from GDScript source. Edit the source file to improve documentation.

Generated on 2025-09-07