TerrainPreview | Grid Placement Docs

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.

Ghost preview for terrain painting: shows the selected terrain's tile at the hovered cell while the placement system is in TERRAIN mode. Implemented as a one-cell TileMapLayer that mirrors the target map's TileSet and global transform, so square and isometric layouts render identically to the real paint result. The ghost look comes from [member preview_self_modulate] (default: subtle ghost blue). Add one inside the PlacementInjectorSystem's injection scope (e.g. under World). It tracks the positioner each frame while visible and repaints only when the hovered cell or selected terrain changes.

Source: addons/grid_placement/systems/building/terrain/terrain_preview.gd

Syntax

class TerrainPreview extends PlacementNode2D

Members

Name	Kind	Summary
`preview_self_modulate`	Property	Ghost tint applied to the preview layer (self_modulate so child nodes, if any are ever added, keep their own colors).
`set_injector_owner`	Method
`resolve_placement_dependencies`	Method
`refresh_now`	Method
`request_refresh`	Method
`active`	Property
`target_map`	Property
`positioner`	Property
`terrain_name`	Property
`preview_cells`	Property
`cell_count`	Property
`last_cell`	Property
`host_brush`	Property
`brush_shape`	Property
`drag_start`	Property
`drag_active`	Property
`pending_active`	Property
`valid_cells`	Property
`invalid_cells`	Property
`entry`	Property
`palette`	Property
`issue_map`	Property
`target_modulate`	Property
`invalid_modulate`	Property
`host`	Property
`injector`	Property
`tree`	Property
`root`	Property
`host`	Property
`valid_cells`	Property
`invalid_cells`	Property
`entry`	Property
`palette`	Property
`issues`	Property
`resolved`	Property
`preview_tileset`	Property

Source

addons/grid_placement/systems/building/terrain/terrain_preview.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs