Placement entry for instancing scene objects into the game world. Carries a [member packed_scene] plus object-specific tool/rule overrides. The canonical replacement for [Placeable] (which is kept as a deprecated alias through the 6.0 deprecation window and scheduled for removal in a future release).
Source: addons/grid_placement/placement/placeable/scene_placement_entry.gd
Syntax
class ScenePlacementEntry extends PlacementEntryMembers
| Name | Kind | Summary |
|---|---|---|
display_name | Property | Display name for in-game reading. |
packed_scene | Property | Scene to instance when placed. |
profiles | Property | Placement profiles for grouping entries with shared behavior. Profiles carry their own [member PlacementProfile.placement_rules] and [member PlacementProfile.supported_object_tools] that layer into the three-tier rule/tool resolution. |
snap_profile_3d | Property | Optional 3D snap-category metadata (family + accept-list). Consulted by [ObjectPlacementService3D] when validating 3D placements; ignored in 2D. |
footprint_2d | Property | Footprint in 2D world units (x, y) for smooth/free placement mode. The object occupies this axis-aligned rectangle centered on its position. Required for smooth placement; default [Vector2.ZERO] makes smooth placement fail closed until a footprint is configured. |
footprint_3d | Property | Footprint in GridMap cells (x, z) for 3D grid placement. The targeted cell is the footprint's minimum corner; validation checks occupancy, ground, and the elevation threshold across every covered column. Ignored in 2D. |
footprint_3d_world | Property | Footprint in 3D world units (x, y, z) for smooth/free placement mode. The object occupies this axis-aligned box centered on its position. Required for smooth 3D placement; default [Vector3.ZERO] means no footprint and the service will fail closed. |
tool_override_mode | Property | How this entry's [member tool_overrides] interact with its profiles' [member PlacementProfile.supported_object_tools]. See [enum ToolOverrideMode]. |
tool_overrides | Property | Tools added or removed depending on [member tool_override_mode]. - [enum INHERIT]: ignored (profiles provide the full list) - [enum REPLACE]: this list IS the full tool set - [enum ADD]: these are unioned with profile tools - [enum REMOVE]: these are subtracted from profile tools |
catalog_locked | Property | When true, catalog UI shows this entry as locked (not selectable). Used by demos to illustrate an unlock-gated placeable without a grey placeholder. |
get_build_costs | Method | |
get_display_name | Method | |
get_load_data | Method | |
load_resource | Method | |
get_packed_root_name | Method | |
resolve_object_tools | Method | |
get_editor_issues | Method | |
get_runtime_issues | Method | |
UID | Field | |
FILE_PATH | Field |