Skip to content

Class

TerrainPlacementService3D

Generated GDScript class reference for GridPlacement.TerrainPlacementService3D.

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.

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

Syntax

class TerrainPlacementService3D extends TerrainServiceContract

Members

NameKindSummary
MSG_TERRAIN_NOT_READYFieldPlayer-facing reason when terrain cannot be painted because the scene is not set up. The setup detail is written to the developer log instead.
terrain_cell_changedSignalFires on every GridMap cell edit made through this service (paint, replace, or erase — erase reports GridMap.INVALID_CELL_ITEM). Games can connect to re-validate placed objects after terrain edits; the policy stays with the game, placement-time validation remains authoritative.
fail_on_identical_repaintPropertyWhen true, repainting identical terrain fails loudly (legacy behavior). Default false: identical repaints read as valid placements that changed nothing, with PlacementReport.placed left null, a "No tiles placed" note, and one acknowledgement in the action log. Rule rejections and config errors always fail loudly regardless of this flag.
supported_dimensionsMethod
set_statesMethod
try_place_terrain_by_nameMethod
resolved_mapProperty
issuesProperty
blockedProperty
noopProperty
itemProperty
reportProperty
validate_terrain_cellMethod
resolved_mapProperty
itemProperty
on_tileProperty
belowProperty
supportedProperty
previous_itemProperty
issuesProperty
resolved_mapProperty
itemProperty
entryProperty
ctxProperty
resultsProperty
paint_cellsMethod
resolved_mapProperty
itemProperty
entryProperty
paintedProperty
rejectedProperty
first_issueProperty
issuesProperty
strict_reportProperty
noopProperty
reasonProperty
empty_reportProperty
reportProperty
erase_cellsMethod
try_demolish_terrainMethod
resolved_mapProperty
terrain_nameProperty
dataProperty
entryProperty
erase_reportProperty
stacked_cellMethod
stacked_paint_targetsMethod
first_cellProperty
countProperty
start_terrain_drag_3dMethod
is_terrain_dragging_3dMethod
cancel_terrain_drag_3dMethod
begin_terrain_paint_segment_3dMethod
get_terrain_paint_segment_3dMethod
preview_terrain_drag_3dMethod
complete_terrain_drag_3dMethod
cellsProperty
take_terrain_drag_cells_3dMethod
capProperty