Describes a scene object that can be placed and its placement options. Add entries to a PlacementCatalog or a SceneEntrySelectionUI. Replaces the 5.x Entry class.
Source: addons/grid_placement/placement/scene_entry/scene_placement_entry.gd
Syntax
class ScenePlacementEntry extends PlacementEntryMembers
| Name | Kind | Summary |
|---|---|---|
display_name | Property | Name shown to players. |
cell_anchor_offset | Method | |
cell_anchor_mode | Property | 2D only. Where on the targeted cell the object's root node is placed. See CellAnchorMode. |
packed_scene | Property | Scene to instance when placed. |
profiles | Property | Profiles that add shared rules, tools, and a catalog category to this entry. See PlacementProfile. |
snap_profile_3d | Property | 3D only. How this object attaches to the grid and to other pieces. |
cell_policy_3d | Property | 3D only. Optional rule the game adds on top of the plugin's occupancy, grounding and attachment checks — see PlacementCellPolicy3D. Leave empty unless the game has a rule of its own (for example one room per storey). |
footprint_2d | Property | Size of the object in 2D world units, for smooth (free) placement. The rectangle is centered on the object. Smooth placement is blocked until this is set. |
surface_size_2d_cells | Property | 2D only. Size, in grid cells, of the top surface other items can be stacked on. A 2x3 table uses Vector2(2, 3) and holds 6 items. Zero (default) means nothing can be stacked on this object. |
surface_height_2d | Property | 2D only. Extra stacking levels this object supports above its top surface. 0 means a single flat surface. A barrel with a lid might use 1. |
stacks_on_surface | Property | 2D only. When on, this object is placed on top of whatever is in the targeted cell, like a book on a table. The table sets surface_size_2d_cells. An object can do both. With nothing to stack on, the object is placed on the ground as usual. |
is_2d_stack_participant | Method | |
footprint_3d | Property | 3D only. Size of the object in GridMap cells (x, z) for grid placement. The targeted cell is the footprint's lowest corner. Every covered cell is checked. |
footprint_3d_world | Property | 3D only. Size of the object in world units, for smooth (free) placement. The box is centered on the object. Smooth placement is blocked until this is set. EDGE pieces in grid placement also use x as their length along the edge and z as their thickness, so a mesh can overhang (such as fence rails) without blocking the next edge. When unset, an EDGE piece takes one edge. |
seam_bounds_3d | Property | 3D only. Bounding box of the scene's meshes, unrotated and relative to the scene root. Used only when PlacementSnapProfile3D.seam_close_to_partner is on. |
custom_min_support_ratio | Property | Overrides ObjectPlacementSettings3D.min_support_ratio for this entry. -1 uses the setting. |
custom_world_up_clearance | Property | Overrides ObjectPlacementSettings3D.world_up_clearance for this entry. -1 uses the setting. |
custom_max_support_planarity_error | Property | Overrides ObjectPlacementSettings3D.max_support_planarity_error for this entry. -1 uses the setting. |
custom_max_unsupported_edge_ratio | Property | Overrides ObjectPlacementSettings3D.max_unsupported_edge_ratio for this entry. -1 uses the setting. |
custom_require_center_support | Property | Overrides ObjectPlacementSettings3D.require_center_support for this entry. Inherit uses the setting. |
tool_override_mode | Property | How tool_overrides changes the placement tools this entry gets from its profiles. |
tool_overrides | Property | Placement tools used with tool_override_mode: - INHERIT: ignored; the profiles' tools are used. - REPLACE: only these tools are used. - ADD: these tools are added to the profiles' tools. - REMOVE: these tools are removed from the profiles' tools. |
is_clearable_decor | Property | 3D only. When on, this object is ground decoration (grass, flowers) that is removed automatically when something else is placed on its cells, instead of blocking it. |
catalog_locked | Property | When on, the catalog shows this entry as locked and it cannot be selected. Use it for objects the player has not unlocked yet. |
get_build_costs | Method | |
get_display_name | Method | |
get_load_data | Method | |
load_resource | Method | |
get_packed_root_name | Method | |
is_grid_socket_mount | Method | |
resolve_object_tools | Method | |
get_editor_issues | Method | |
UID | Field | |
FILE_PATH | Field |