Values for an attempted placement action
Source: addons/grid_placement/systems/building/placement_action_data.gd
Syntax
class PlacementActionData extends RefCountedMembers
| Name | Kind | Summary |
|---|---|---|
INVALID_CELL | Field | |
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 with a successful report and placed == null acknowledges an unchanged paint. Otherwise 0 means the count is unknown (legacy callers). >1 means a multi-cell brush (LINE, RECTANGLE_FILL, FLOOD_FILL) was used. |
attempted_count | Property | Bulk object summary counts (AREA summaries only). attempted_count is how many cells the shape commit tried; placed_count is how many actually placed. Both 0 means this is not a bulk summary (single item or backward-compat path). |
placed_count | Property | |
blocked_issues | Property | First-issue text per blocked cell of a bulk summary (AREA summaries only). Sweeps skip invalid tiles but must not hide them: listeners combine these by normalized reason so one line names what failed and how often. Empty for full successes and backward-compat callers. |
get_display_name | Method | |
get_built_resource | Method | |
is_tile_paint | Method | |
get_preview | Method | |
get_placed_position | Method | |
build_terrain_action | Method | |
build_object_action | Method | |
build_bulk_object_action | Method | |
data | Property |