Chris' Tutorials
Docs/Grid Placement

Class

ObjectPlacementSettings3D

Generated GDScript class reference for GridPlacement.ObjectPlacementSettings3D.

StatusDraft
Versionv6.0
UpdatedDevelopment docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

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.

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.

Source

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

Plugin docs root:gdscript/plugins/grid_placement_dev/docs