Skip to content

Class

ObjectMountRegistry3D

Generated GDScript class reference for GridPlacement.ObjectMountRegistry3D.

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.

Local GRID mount projection of [ObjectPlacementService3D]: which committed node holds each column, edge, corner, face, and top socket, and the mount each node was placed on. The [PlacementWorldRegistry] stays the shared authority; this is the service's fast per-socket index of it. Validation reads these maps through [member PlacementValidation3D.PlacementValidationContext3D.mounts]. Every mutation bumps [member revision] so cached validation can tell the state changed.

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

Syntax

class ObjectMountRegistry3D extends RefCounted

Members

NameKindSummary
nodePropertyEverything the registry holds for one node, captured before a move or removal so it can be put back exactly.
had_projectionPropertyTrue when the node held any socket or mount record.
occupiedProperty
familiesProperty
overlay_cellsProperty
overlay_indicesPropertyIndex the node held in each [member overlay_cells] overlay stack, or -1 when unknown. Absent on a projection built before this field existed.
edgesProperty
edge_familiesProperty
cornersProperty
facesProperty
face_occupancyProperty
topsProperty
top_familiesProperty
top_indicesPropertyIndex the node held in each [member tops] TOP stack, or -1 when unknown. A mid-stack node (a story wall under roofs) must come back at its own index, not as the head. Absent on a projection built before this field.
placedProperty
placement_recordProperty
occupiedPropertyColumn key -> occupying CELL node.
familiesPropertyColumn key -> snap family of the occupying CELL node.
overlay_nodesPropertyColumn key -> Array of the non-occupying CELL overlays stacked on it.
placed_nodesProperty
edgesPropertyEdge key -> mounted node, and its snap family.
edge_familiesProperty
cornersPropertyCorner key -> mounted node.
facesPropertyFace key -> providing node and its family, rebuilt from the records.
face_familiesProperty
face_occupancyPropertyFace occupancy key (face + height band) -> mounted node.
topsPropertyTop key -> head of the stack mounted there, and its family.
top_familiesProperty
top_stacksPropertyTop key -> bottom-to-top Array of mounted nodes (story walls under roofs).
placement_recordsPropertyNode -> the [PlacementMount] it was placed on.
revisionPropertyIncremented by every mutation.
mount_ofMethod
applyMethod
removeMethod
captureMethod
restoreMethod
push_topMethod
stackProperty
headProperty
pop_topMethod
add_overlayMethod
has_face_dependentsMethod
has_top_dependentsMethod
has_live_dependentsMethod
mountProperty
edge_keyProperty
profileProperty
yaw_stepsProperty
provider_facesProperty
providerProperty
settingsProperty
carried_transformProperty
corner_mountProperty
profileProperty
hosted_withoutProperty
providerProperty
edge_nodeProperty
mountProperty
entryProperty
hosted_withoutProperty
providerProperty
mountProperty
entryProperty
hosted_withoutProperty
providerProperty
mountProperty
entryProperty
hosted_withoutProperty
prune_invalidMethod
clearMethod
snapshotMethod
restore_fromMethod