Component to attach to objects that are placed by the building system by remembering the placeable resource that they were instanced from
Source: addons/grid_placement/components/placeable_instance.gd
Syntax
class PlaceableInstance extends PlacementGameNodeMembers
| Name | Kind | Summary |
|---|---|---|
placeable_path_changed | Signal | |
placeable_path | Property | Path to the placeable resource that creates or recreates instances of this gameplay object type |
default_name | Field | |
group_name | Field | |
placeable | Property | |
placement_instance_id | Property | Stable, 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 [method ensure_placement_instance_id] is called. |
ensure_placement_instance_id | Method | |
is_valid_placement_instance_id | Method | |
saved_mount_data | Property | Opaque, 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_data | Property | Game-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_dependencies | Method | |
validate_setup | Method | |
save | Method | |
instance_from_save | Method | |
INSTANCE_NAME | Field | Shared name constants Be very careful about changing these because game saves do not know if you change the string key of loaded properties. |
PLACEABLE | Field | |
TRANSFORM | Field | |
MOUNT | Field | Authoritative placement-registration record (mount type, cell, edge/face keys) merged in by the demo's save path. |
PLACEMENT_INSTANCE_ID | Field | Stable persisted instance identifier. |
WORLD_RECORD | Field | Complete dimension/mode/mount/transform authority record. |