Skip to content

Class

SmoothPlacementService3D

Generated GDScript class reference for GridPlacement.SmoothPlacementService3D.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

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

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
SERVICE_NAMEFieldTag on this service's player-facing issues; the messages themselves are shared on [PlacementCommitAttempt].
positionPropertyWhere a cursor position resolves to: grounded, or snapped to a socket.
yawProperty
socket_idPropertySocket the pose consumes; empty when it did not snap.
snappedProperty
ground_missPropertyThe ground ray found nothing under an unsnapped pose.
socket_required_missPropertyThe entry must attach to a socket and none was in range.
is_okMethod
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.
MOVE_REFUSAL_HAS_DEPENDENTSFieldRefusal text for a provider that cannot move because other pieces are mounted on it. One wording for the one rule, shared with the GRID service and the host move/rotate gate.
last_resolvePropertyLast pose resolved by a preview, validation, or commit; null before any.
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_decor_resolverMethod
set_decor_clearerMethod
set_preview_diagnostic_sinkMethod
configureMethod
get_last_reportMethod
create_preview_atMethod
move_preview_toMethod
rotate_previewMethod
validate_atMethod
yawProperty
resolvedProperty
posProperty
use_yawProperty
conflictProperty
try_placeMethod
attemptProperty
configuration_issueProperty
yawProperty
resolvedProperty
nodeProperty
node3dProperty
authored_scaleProperty
instance_idProperty
footprintProperty
consumed_idProperty
boundsProperty
decor_snapshotProperty
world_recordProperty
lifecycleProperty
world_aabbMethod
rehydrate_recordMethod
footprintProperty
positionProperty
yawProperty
smooth_projectionProperty
projectionProperty
consumed_idProperty
registeredProperty
unregister_placed_nodeMethod
instance_idProperty
consumed_idProperty
sockets_okProperty
update_placed_nodeMethod
old_recordProperty
old_transformProperty
occupancy_snapshotProperty
socket_snapshotProperty
consumed_idProperty
instance_idProperty
entryProperty
updatedProperty
get_last_move_refusalMethod
clear_previewMethod
apply_preview_validityMethod
get_previewMethod
has_previewMethod
ground_yProperty
resultProperty