Skip to content
Grid Building Docs

BuildingSettings

Summary

Section titled “Summary”

Configuration settings for the building system’s behavior and appearance.

Controls preview display, multi-build functionality, instance management, and other building-related parameters.

Properties

Section titled “Properties”
preview_kept_script_types: Array[String] = [“Manipulatable”]

List of Script Global Class Names that will be kept for preview instances when placing objects in build mode.

preview_kept_script_types: Array[String] - Script class names to preserve during preview creation

add_placeable_instance = true

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.

WARNING: 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 Placeable file.

add_placeable_instance: bool - Whether to automatically add PlaceableInstance component to placed objects

preview_instance_z_index = 100

The z index value to set preview instances to in order to control their rendering order.

preview_instance_z_index: int - Z-index for preview instance display ordering

drag_multi_build = false

Whether to allow multi build by holding the build button down as the positioner is moved over other tiles.

drag_multi_build: bool - Enable drag-to-build multiple objects functionality

Methods

Section titled “Methods”
get_editor_issues( ) -> Array[String]
get_runtime_issues( ) -> Array[String]

Source

Section titled “Source”

addons/grid_building/systems/building/building_settings.gd

This page was auto-generated from GDScript source. Edit the source file to improve documentation.

Generated on 2025-09-07