Skip to content

Class

SmoothSocketRegistry3D

Generated GDScript class reference for GridPlacement.SmoothSocketRegistry3D.

Status
Current
Version
v6.2.0
Source updated
2026-09-24
Generated on
2026-10-01

World-space sockets for 3D SMOOTH object-to-object snap. Parallel to GRID EDGE/FACE keys, but the id is (provider_instance_id, role, index) — never a GridMap cell. Exclusive occupancy: one consumer per socket.

Source: addons/grid_placement/services/smooth_socket_registry_3d.gd

Syntax

class SmoothSocketRegistry3D extends RefCounted

Members

NameKindSummary
ROLE_NAMESField
idPropertyOne published socket. The registry hands out copies, so a caller can never mutate registry state through a returned record.
provider_idProperty
roleProperty
indexProperty
originProperty
yawProperty
familyProperty
outwardProperty
cornerProperty
occupied_byProperty
provider_half_xPropertyProvider top-face half extents; only UP corner sockets set them.
provider_half_zProperty
distancePropertyDistance from the query point; only [method nearest] sets it.
is_occupiedMethod
copyMethod
socket_idMethod
clearMethod
publish_endsMethod
basisProperty
idsProperty
publish_perimeterMethod
basisProperty
offsetsProperty
yawsProperty
idsProperty
world_offsetProperty
publish_upMethod
publish_up_cornersMethod
basisProperty
idsProperty
signsProperty
cornerProperty
localProperty
worldProperty
outwardProperty
idProperty
unpublish_providerMethod
occupyMethod
releaseMethod
release_consumerMethod
is_occupiedMethod
get_socketMethod
nearestMethod
bestProperty
best_distProperty
distProperty
hitProperty
occupy_nearest_ownedMethod
best_idProperty
best_distProperty
distProperty
sizeMethod
snapshot_stateMethod
restore_stateMethod
idProperty
socketProperty