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.
Configuration settings for the placement system's behavior and appearance. Controls preview display, multi-placement functionality, instance management, and other placement-related parameters.
Source: addons/grid_placement/systems/building/placement_settings.gd
Syntax
class PlacementSettings extends PlacementResourceMembers
| Name | Kind | Summary |
|---|---|---|
preview_kept_script_types | Property | List of Script Global Class Names that will be kept for preview instances when placing objects in build mode.[br][br] [code]preview_kept_script_types[/code]: [i]Array[String][/i] - Script class names to preserve during preview creation |
add_placeable_instance | Property | Add a placeable instance component node automatically to any instance objects placed by the building system. This node holds a reference to the placeable that created it to reinstate the scene between level loads.[br][br] [b]WARNING:[/b] It does this using file_path to the placeable resource. Files can move around a lot so you may consider implementing an ID database for looking up Placeables instead during gameplay to avoid losing reference the ScenePlacementEntry file.[br][br] [code]add_placeable_instance[/code]: [i]bool[/i] - Whether to automatically add PlaceableInstance component to placed objects |
preview_instance_z_index | Property | The z index value to set preview instances to in order to control their rendering order.[br][br] [code]preview_instance_z_index[/code]: [i]int[/i] - Z-index for preview instance display ordering |
indicator_z_index | Property | The z index applied to rule check indicators so validity feedback renders above the placement preview (see [member preview_instance_z_index]).[br][br] [code]indicator_z_index[/code]: [i]int[/i] - Z-index for rule check indicator display ordering |
base_tile_paint_rules | Property | Global list of rules to validate for all tile paint actions. |
terrain_paint_requires_existing_cell | Property | When true, terrain painting requires an existing cell at the target position — terrain re-paints the map's surface instead of expanding into the void. When false (default, legacy behavior), painting empty space creates new cells.[br][br] [code]terrain_paint_requires_existing_cell[/code]: [i]bool[/i] - Gate terrain paints to occupied cells |
max_terrain_brush_cells | Property | Maximum cells a terrain brush operation (line, rectangle fill/outline, flood fill) can generate in a single action. Prevents frame spikes from unbounded drags. The runtime hard-ceiling is 16,384 cells regardless of this setting; the inspector value is clamped to [1, 16384].[br][br] [code]max_terrain_brush_cells[/code]: [i]int[/i] - Per-action cell cap for terrain brush shapes |
preview_root_script | Property | Script to be added to the root of any preview instance node temporarily created by the building system after non-kept scripts are stripped out. Does not override an existing script in the root. |
get_editor_issues | Method | |
get_runtime_issues | Method |
Source
addons/grid_placement/systems/building/placement_settings.gd
Plugin docs root:gdscript/plugins/grid_placement_dev/docs