Skip to content

Class

ObjectPlacementPreviewSlots3D

Generated GDScript class reference for GridPlacement.ObjectPlacementPreviewSlots3D.

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.

Parked per-session selection/preview slots for [ObjectPlacementService3D]. Split-screen players share one 3D service: committed occupancy is one world, but each session keeps its own selected entry, ghost, yaw, mount, and replace-hidden node. The service holds the bound session's slot in its own fields; this store holds every other session's [Slot], keyed by session id, and owns their presentation cleanup. It never validates or commits. [ObjectPlacementService3D.capture_preview_slot] / [ObjectPlacementService3D.restore_preview_slot] return and accept [ObjectPlacementPreviewSlots3D.Slot], so a caller that temporarily borrows a session (a headless placement command) owes the full slot back — entry, ghost, tint, ring, cell, yaw, mount, and the drag-span pool — not just the selected entry.

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

Syntax

class ObjectPlacementPreviewSlots3D extends RefCounted

Members

NameKindSummary
entryPropertyOne session's parked selection and preview presentation. A fresh slot holds the service's empty defaults.
ghostProperty
ghost_validProperty
hidden_replacedProperty
tintPropertyNull restores a fresh tint/ring.
ringProperty
cellProperty
yawProperty
mountProperty[enum ObjectPlacementService3D.PreviewMount]; 0 is NONE.
pool_ghostsPropertyDrag-span ghosts and their verdicts.
pool_validsProperty
clear_placementMethod
bound_poolProperty
capture_fromMethod
restore_intoMethod
parkMethod
takeMethod
forgetMethod
hide_previewMethod
free_ghostsMethod
clearMethod