Skip to content

Class

ObjectPlacementSettings3D

Generated GDScript class reference for GridPlacement.ObjectPlacementSettings3D.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

Configuration for [ObjectPlacementService3D]: preview tint colors and the v1 ground/validation knobs.

Source: addons/grid_placement/systems/building/3d/object_placement_settings_3d.gd

Syntax

class ObjectPlacementSettings3D extends Resource

Members

NameKindSummary
valid_colorPropertyTint applied to the preview ghost when the pending placement is valid.
invalid_colorPropertyTint applied to the preview ghost when the pending placement is invalid.
surface_offsetPropertyExtra vertical fudge added on top of the resolved surface (the mesh AABB top of the highest occupied cell in the column). Usually 0 — the AABB scan already accounts for slab vs full-block item heights.
require_ground_cellPropertyWhen true, every footprint column must resolve ground within the scan range (i.e. you can only place on built floor/terrain).
max_elevation_deltaPropertyMaximum allowed surface-height difference (world units) across a footprint. Beyond this the placement is rejected as "too steep".
surface_scan_max_yPropertyHighest GridMap y layer probed when resolving a column's surface.
surface_scan_min_yPropertyLowest GridMap y layer probed when resolving a column's surface.