Skip to content

Class

ObjectPlacementService3D

Generated GDScript class reference for GridPlacement.ObjectPlacementService3D.

Status
Current
Version
v6.0
Source updated
2026-09-04
Generated on
2026-09-06

Scene-free 3D object placement service. Owns preview/commit orchestration for 3D sessions. CELL validity is delegated to [PlacementValidation3D], including optional physics-backed surface support; EDGE/FACE/socket policy remains on the same shared validation seam.

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

Syntax

class ObjectPlacementService3D extends RefCounted

Members

NameKindSummary
object_placedSignal
preview_validity_changedSignal
active_entry_changedSignal
MISSField
GHOST_ALPHA_SCALEFieldGhost tint alpha scale (applied to the ghost wash colors). Below 1.0 so transient overlaps with committed geometry blend softly instead of clipping into hard bands.
NO_GROUNDField
GHOST_VALID_NEUTRALFieldNeutral wash for a valid pending placement. The ghost shows WHERE the object will land (guide: "Preview object vs mount indicator"); the verdict lives on the per-cell mount indicators, not in a full-volume green slab that hides the piece and washes against the ground. Blocked placements keep the invalid-color wash, so HIDDEN presentation (no quads) still reads valid (neutral ghost) vs blocked (red ghost).
set_preview_diagnostic_sinkMethod
set_decision_diagnostic_sinkMethod
configureMethod
configure_lifecycleMethod
get_settingsMethod
is_configuredMethod
set_active_entryMethod
get_active_entryMethod
update_preview_cellMethod
is_preview_validMethod
get_preview_cellMethod
clear_previewMethod
rotate_previewMethod
get_preview_yaw_stepsMethod
preview_yaw_degreesMethod
validate_cell_mapMethod
validate_cellMethod
positionProperty
authorityProperty
basisProperty
normalProperty
profileProperty
dirsProperty
footprintProperty
try_place_reportMethod
populate_surface_metadataMethod
authorityProperty
cellsProperty
max_surfaceProperty
surface_nameProperty
surfaceProperty
try_place_atMethod
is_cell_occupiedMethod
get_placed_nodeMethod
get_family_atMethod
get_placed_countMethod
is_edge_occupiedMethod
is_corner_occupiedMethod
is_face_registeredMethod
is_face_occupiedMethod
validate_edgeMethod
update_preview_edgeMethod
try_place_at_edgeMethod
try_place_report_edgeMethod
validate_faceMethod
update_preview_faceMethod
try_place_at_faceMethod
try_place_report_faceMethod
validate_cornerMethod
update_preview_cornerMethod
try_place_at_cornerMethod
try_place_report_cornerMethod
lifecycleProperty
instance_idProperty
projectionsProperty
provider_facesProperty
projectionsProperty
provider_facesProperty
profileProperty
occupy_columnsProperty
keyProperty
edge_keyProperty
profileProperty
face_keyProperty
keyProperty
face_keyProperty
occupancy_keyProperty
world_aabb_for_mountMethod
unregister_placed_nodeMethod
unregister_placed_node_localMethod
local_snapshotProperty
world_recordProperty
snapshotProperty
update_placed_nodeMethod
old_grid_cellProperty
new_grid_cellProperty
profileProperty
familyProperty
cellsProperty
height_bandProperty
disposeMethod
clear_placement_registriesMethod
snapshot_placement_stateMethod
restore_placement_stateMethod
rehydrate_cell_objectMethod
yaw_stepsProperty
profileProperty
familyProperty
cellsProperty
mountProperty
occupancy_evidenceProperty
mountProperty
rehydrate_corner_objectMethod
mountProperty
rehydrate_face_objectMethod
mountProperty
height_bandProperty
get_save_metadataMethod
get_placed_nodesMethod
cell_from_world_positionMethod
cell_from_world_pointMethod
sinkProperty
entry_pathProperty
definition_keyProperty
contextProperty