Skip to content

Class

SceneEntryInstance

Generated GDScript class reference for GridPlacement.SceneEntryInstance.

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.

Remembers which placement entry a placed object was created from. Added automatically to placed objects when PlacementSettings.add_entry_instance is on. Used to rebuild objects on load and to look up their build cost.

Source: addons/grid_placement/components/scene_entry_instance.gd

Syntax

class SceneEntryInstance extends PlacementSystemsComponent

Members

NameKindSummary
entry_path_changedSignalEmitted when entry_path changes.
entry_pathPropertyPath to the placement entry resource (.tres or .res) this object was created from.
default_nameField
group_nameField
scene_entryProperty
placement_instance_idPropertyStable, persisted instance identifier for this placed object. Generated once at first commit; survives save/load, move, rotate, flip, demolish preparation, and scene reparenting. Uses a UUID-style random ID. Never derived from Object.get_instance_id(), node path, transform, or session identity. Empty until ensure_placement_instance_id() is called.
ensure_placement_instance_idMethod
find_inMethod
ensure_onMethod
is_valid_placement_instance_idMethod
saved_mount_dataPropertyOpaque, dimension-neutral restore metadata carried through a save/load round trip. The shared component preserves this dictionary exactly as the demo's save path merged it in; the internal 3D persistence layer reconstructs a typed mount from it and dispatches via the 3D mount service. Empty for legacy saves and for purely 2D placements — the 3D subscriber falls back to deterministic cell reconstruction from the transform. Kept as a plain Dictionary so this shipped component does not depend on any 3D type.
saved_game_dataPropertyGame-owned save fields carried through a restore/re-save cycle. Plugin-owned fields are written after this dictionary and therefore always win conflicts.
resolve_placement_dependenciesMethod
validate_setupMethod
saveMethod
instance_from_saveMethod
INSTANCE_NAMEFieldShared name constants Be very careful about changing these because game saves do not know if you change the string key of loaded properties.
ENTRYField
TRANSFORMField
MOUNTFieldAuthoritative placement-registration record (mount type, cell, edge/face keys) merged in by the demo's save path.
PLACEMENT_INSTANCE_IDFieldStable persisted instance identifier.
WORLD_RECORDFieldComplete dimension/mode/mount/transform authority record.
DIMENSIONFieldKeys of the world record itself.
COORDINATE_MODEField
ORIENTATIONField
SMOOTH_CONSUMEDField