Skip to content
ct

Class

ScenePlacementEntry

Generated GDScript class reference for GridPlacement.ScenePlacementEntry.

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.

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 PlacementEntry

Members

NameKindSummary
display_namePropertyDisplay name for in-game reading.
packed_scenePropertyScene to instance when placed.
profilesPropertyPlacement 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_3dPropertyOptional 3D snap-category metadata (family + accept-list). Consulted by [ObjectPlacementService3D] when validating 3D placements; ignored in 2D.
footprint_2dPropertyFootprint 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_3dPropertyFootprint 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_worldPropertyFootprint 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_modePropertyHow this entry's [member tool_overrides] interact with its profiles' [member PlacementProfile.supported_object_tools]. See [enum ToolOverrideMode].
tool_overridesPropertyTools 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
get_build_costsMethod
get_display_nameMethod
get_load_dataMethod
load_resourceMethod
get_packed_root_nameMethod
resolve_object_toolsMethod
get_editor_issuesMethod
get_runtime_issuesMethod
UIDField
FILE_PATHField