BuildingSettings

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

Source File: addons/grid_building/systems/building/building_settings.gd

Extends: GBResource

Exported Properties

  • Property: 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

  • Property: 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

  • Property: 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

  • Property: preview_root_script : Script = load("res://addons/grid_building/components/building_node.gd")

    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.

Public Methods

get_editor_issues

1

get_editor_issues() -> Array[String]

get_runtime_issues

1

get_runtime_issues() -> Array[String]