Skip to content

Class

SmoothPlacementService3D

Generated GDScript class reference for GridPlacement.SmoothPlacementService3D.

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

Smooth/free 3D placement service for exact world-position placement. 3D counterpart of [SmoothPlacementService]. Provides preview, occupancy validation via [SmoothOccupancyRegistry3D], and commit at arbitrary [Vector3] world positions.

Source: addons/grid_placement/services/smooth_placement_service_3d.gd

Syntax

class SmoothPlacementService3D extends RefCounted

Members

NameKindSummary
occupancy_registryPropertyThe smooth occupancy registry. Must be configured before placement.
world_registryPropertyShared committed-placement authority for this level. A 3D smooth commit is rejected until this registry is configured.
attachment_settingsPropertyShared 3D placement settings authority. Host-owned services bind the same resource used by GRID; null preserves standalone historical OPTIONAL behavior.
occupied_maskPropertyOptional physics blocker mask. Physics is validation evidence only; blocked external objects never enter the placement-world registry.
ground_collision_maskPropertyOptional Ground-collider ray. 0 keeps the supplied Y (free SMOOTH).
ground_ray_origin_yProperty
ground_ray_end_yProperty
socket_registryPropertyWorld-space sockets. Parallel to GRID EDGE, never cell-keyed.
last_resolvePropertyLast pose resolve from preview/commit (position, yaw, socket_id, snapped).
objects_parentPropertyParent node for committed placements. Must be set before [method try_place].
lifecycle_allocatorPropertyPlugin-owned allocator for attempt/reservation IDs configured by the host.
world_idPropertyWorld and session identifiers surfaced on the canonical lifecycle result.
session_idProperty
set_preview_diagnostic_sinkMethod
configureMethod
get_last_reportMethod
create_preview_atMethod
move_preview_toMethod
rotate_previewMethod
validate_atMethod
try_placeMethod
lifecycleProperty
world_aabbMethod
rehydrate_recordMethod
footprintProperty
positionProperty
yawProperty
smooth_projectionProperty
projectionProperty
consumed_idProperty
registeredProperty
unregister_placed_nodeMethod
instance_idProperty
consumed_idProperty
update_placed_nodeMethod
old_recordProperty
old_transformProperty
occupancy_snapshotProperty
consumed_idProperty
instance_idProperty
entryProperty
updatedProperty
old_projProperty
Property
clear_previewMethod
apply_preview_validityMethod
get_previewMethod
has_previewMethod
resultProperty
groundedProperty
profileProperty
consumeProperty
queryProperty
hitProperty
posedProperty
profileProperty
consumedProperty