Skip to content

Class

ObjectMountRegistry3D

Generated GDScript class reference for GridPlacement.ObjectMountRegistry3D.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

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 PlacementValidation3D.PlacementValidationContext3D.mounts. Every mutation bumps 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 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 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
occupiedPropertyCell key (the piece's OWN storey, so two storeys of one column both fit) -> occupying CELL node, and its snap family. Keys carry `y`: a room on storey 1 books the cells at `y = 1`, which is what lets one entry be placed on the ground and again above itself. Attachments stay storey-agnostic and read a column through occupant_in_column().
familiesPropertyCell 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
occupant_atMethod
occupant_in_columnMethod
family_in_columnMethod
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