Skip to content

Class

FaceMountResolver3D

Generated GDScript class reference for GridPlacement.FaceMountResolver3D.

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.

FACE-mount mate policy for 3D object placement (declared-socket design). Stateful placement state lives in [ObjectPlacementService3D]; this class is the pure policy layer the service consults. Everything here is static and side-effect free: the caller supplies the face's provider node, the entry, and the grid context, and gets back a typed decision. Resolution contract: when the provider wall carries a declared FaceSocket node AND the consumer entry's [PlacementSnapProfile3D] names its face_mount_anchor child, the returned transform is the exact socket mate (socket · anchor⁻¹) so the piece sits flush on the authored face plane by construction. Otherwise the legacy cell-derived face plane serves the mount and [member Resolution.socket_declared] is false, so callers can log/verify which path served the transform.

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

Syntax

class FaceMountResolver3D extends RefCounted

Members

NameKindSummary
transformPropertyTyped result of one FACE-mount resolution. World-space transform the consumer should be mounted at.
socket_declaredPropertyTrue when [member transform] is an exact declared-socket mate; false when the legacy cell-derived fallback served the mount.
resolveMethod
socketProperty
anchor_nameProperty
outward_firstProperty
chainProperty
mateProperty
exactProperty
fallbackProperty
keyProperty
tmpProperty
chainProperty
provider_face_keys_for_mountMethod
resultProperty
yaw_stepsProperty
cellsProperty
can_share_provider_faceMethod
providersProperty
familyProperty
exposed_provider_facesMethod
resultProperty
nodeProperty
mountProperty
profileProperty