Skip to content

Class

PlacementWorldRecord

Generated GDScript class reference for GridPlacement.PlacementWorldRecord.

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.

One committed Grid Placement object in a placement world. This deliberately excludes arbitrary scene and physics objects.

Source: addons/grid_placement/services/placement_world_record.gd

Syntax

class PlacementWorldRecord extends RefCounted

Members

NameKindSummary
COORDINATE_MODE_GRIDFieldWire names for coordinate_mode in the saved world record.
COORDINATE_MODE_SMOOTHField
placement_instance_idProperty
scene_entryProperty
dimensionProperty
coordinate_modeProperty
mount_dataProperty
occupancy_evidencePropertyDimension-specific immutable conflict evidence (for example a 3D AABB or 2D Rect2).
root_refProperty
generationProperty
transformPropertyThe committed runtime transform. Mount records keep their orientation here even though their socket evidence is intentionally excluded from the cross-mode AABB projection.
orientationProperty
projectionsPropertyExplicit projection ledger. A single record may own GRID, SMOOTH, mount, identity, and callback projections at the same time.
removal_callbackPropertyCallback invoked by the registry when this root exits its generation. Signature: (p_record, p_force) -> bool. When p_force is true the root is already dead (tree-exit or dead-record sweep): the adapter must drop its projection unconditionally, and the registry ignores a refusal. A veto may only refuse the live (p_force == false) path. Deliberately kept off the save representation.
exit_callbackProperty
mount_classificationPropertyStable mount classification and target evidence for consumers that should not parse the serialized mount dictionary themselves.
mount_target_evidenceProperty
rootMethod
clone_for_generationMethod
to_save_dataMethod
coordinate_mode_to_wireMethod
is_wire_coordinate_modeMethod
coordinate_mode_from_wireMethod