Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.
Source: addons/grid_placement/systems/building/placement_action_data.gd
Syntax
class PlacementActionData extends RefCountedMembers
| Name | Kind | Summary |
|---|---|---|
INVALID_CELL | Field | Values for an attempted placement action |
placeable | Property | The resource defining the rules and scene to instance for a placeable object |
build_resource | Property | The active resource used for the build action. May be a ScenePlacementEntry. Terrain-name painting keeps the TileSet as SSOT and does not attach a duplicate terrain resource. |
report | Property | The placement report from the attempted action |
build_type | Property | Type of build operation (SINGLE, DRAG, TERRAIN, or AREA) |
terrain_name | Property | Semantic terrain name for tile-paint actions (TERRAIN). The TileSet is the SSOT for terrain identity, so no separate terrain resource is attached; the name is the user-facing label for action-log output and similar listeners. Empty for non-terrain build types. |
terrain_cell | Property | Grid cell where terrain was painted (TERRAIN actions only). This enables per-cell cost deduction, undo journaling, and effects. For non-terrain actions, this value is INVALID_CELL. |
terrain_cell_count | Property | Number of cells painted in this terrain operation (TERRAIN actions only). 0 means the count is unknown (e.g. single-cell backward compat). >1 means a multi-cell brush (LINE, RECTANGLE_FILL, FLOOD_FILL) was used. |
get_display_name | Method | |
resource | Property | |
get_built_resource | Method | |
is_tile_paint | Method | |
get_preview | Method | |
get_placed_position | Method | |
build_terrain_action | Method | |
build_object_action | Method |
Source
addons/grid_placement/systems/building/placement_action_data.gd
Plugin docs root:gdscript/plugins/grid_placement_dev/docs