BuildingSystem

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

Manages placement of objects in the game world.

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

Extends: GBSystem

Properties

  • Property: placement_polygons: Array[CollisionPolygon2D] - Collision polygons for placement indicators.
  • Property: preview_layer: int - Preview layer index for buildable/unbuildable tiles.
  • Property: selected_placeable: [Placeable](./placeable/) - Currently selected placeable resource.
  • Property: indicators_group: Node2D - Parent node for collision indicators.

Private Properties

  • Property: _building_instantiator : [BuildingInstantiator](./building-instantiator/) (private) - Instantiates building objects for placement.

  • Property: _building_settings : [BuildingSettings](./building-settings/) (private) - Settings for grid building system operation.

  • Property: _states : [GBStates](./gb-states/) (private) - Shared states for plugin systems.

  • Property: _systems_context : [GBSystemsContext](./gb-systems-context/) (private) - Context for resolving references to current objects.

  • Property: _indicator_context : [IndicatorContext](./indicator-context/) (private) - Placement management and rules context.

  • Property: _actions : [GBActions](./gb-actions/) (private)

  • Property: _logger : [GBLogger](./gb-logger/) (private)

  • Property: _container: [GBCompositionContainer](./gb-composition-container/) (private) - Keep a reference to the container for lazy component creation

  • Property: _cleaning_up: bool = false (private)

    Guard flag to prevent re-entrant calls to _exit_build_cleanup. Reset in exit_build_mode() to prevent leakage across scene_runner test cycles.

  • Property: _preview_builder : [PreviewBuilder](./preview-builder/) (private)

  • Property: _report : [PlacementReport](./placement-report/) (private) - The report of the active ongoing placement

  • Property: _build_drag_event: InputEventScreenDrag (private)

    Tracks drag events for build button. InputEventScreenDrag instance used to track drag events for build actions. Updated as the user drags to new tiles during multi-build mode.

Constants

  • Constant: WARNING_INVALID_PLACEABLE = "Invalid placeable resource. Can't instantiate. [%s]"
  • Constant: WARNING_NO_PREVIEW = "No preview instance created to instantiate yet. Returning null."

Public Methods

create_with_injection

1

create_with_injection(container: GBCompositionContainer) -> BuildingSystem

Flags: static

Creates a BuildingSystem with injected dependencies from the container.

get_building_state

1

get_building_state() -> BuildingState

legacy accessors expected in some validator/integration tests

get_targeting_state

1

get_targeting_state() -> GridTargetingState

is_ready_to_place

1

is_ready_to_place() -> bool

Returns true if system is ready to place a selected placeable (should already be set) Checks if the system is ready to build by validating the selected placeable and build context. Returns true if all build requirements are met and no issues are found.

is_in_build_mode

1

is_in_build_mode() -> bool

Returns true if the building system is currently in build mode. Checks the current mode state to determine if build mode is active.

exit_build_mode

1

exit_build_mode() -> void

Exits build mode and cleans up all build-related elements. Resets the _cleaning_up guard to prevent leakage across scene_runner test cycles.

resolve_gb_dependencies

1

resolve_gb_dependencies(p_container : GBCompositionContainer) -> void

try_build

1

try_build(p_build_type: GBEnums.BuildType = GBEnums.BuildType.SINGLE) -> PlacementReport

Attempts to place a building at the current preview location if all placement rules pass. Validates all placement rules and emits success or failure signals based on the result. Returns the built Node2D if successful, null otherwise.

p_build_type Type of build operation (SINGLE, DRAG, or AREA). Defaults to SINGLE.

try_build_at_position

1

try_build_at_position(p_global_position: Vector2) -> PlacementReport

Legacy API compatibility method for tests Attempts to place a building at the specified position Temporarily moves the targeting system to the position, attempts placement, then restores position

enter_build_mode

1

enter_build_mode(p_placeable: Placeable) -> PlacementReport

Sets up a preview instance for the selected placeable. Switches to build mode, clears previous preview, and creates a new preview instance. Returns true if setup is successful.

p_placeable: Placeable - Placeable resource to create preview for

clear_preview

1

clear_preview() -> void

Removes the current preview instance. Removes the current preview instance and resets placement manager state. Called when exiting build mode or clearing preview.

instance_preview

1

instance_preview(p_placeable: Placeable) -> Node2D

Creates a preview instance with limited functionality. Strips scripts not needed for preview and replaces root node script if set in config. Used for visual feedback before placement.

p_placeable: Placeable - Placeable resource to create preview instance for

get_runtime_issues

1

get_runtime_issues() -> Array[String]

Validates that all required dependencies are set. This is called automatically when entering build mode, but can also be called manually after scene loads to check if all dependencies are properly configured. Returns list of validation issues (empty if valid).

get_builder_owner

1

get_builder_owner() -> GBOwner

Get the current GBOwner of the building object which is the root node of the GBOwner in the active GBOwnerContext that is assigned to the BuildingState

report_built

1
2
3
4

report_built(
    p_report : PlacementReport,
    p_build_type: GBEnums.BuildType = GBEnums.BuildType.SINGLE
) -> void

Connects BuildingSystem to a DragManager scene component for drag-building support. Reports a successful build action through the BuildingState

p_report The placement report for the build action p_build_type Type of build operation (SINGLE, DRAG, or AREA)

report_failure

1
2
3
4

report_failure(
    p_report : PlacementReport,
    p_build_type: GBEnums.BuildType = GBEnums.BuildType.SINGLE
) -> void

Reports a failed build action through the BuildingState

p_report The placement report for the build action p_build_type Type of build operation (SINGLE, DRAG, or AREA)

Private Methods

_exit_build_cleanup

1

_exit_build_cleanup() -> void

Flags: private

Cleans up build mode elements and resets indicators. Uses a _cleaning_up guard to prevent re-entrant calls from multiple exit paths. The guard flag is NOT reset at the end — it’s reset by exit_build_mode() or _on_mode_changed() before the next cleanup cycle. This prevents the mode_changed signal callback from defeating the guard for the subsequent direct call.

_unhandled_input

1

_unhandled_input(event: InputEvent) -> void

Flags: private

Handles input for building controls. Handles input events for building controls, including build confirmation and mode switching. Processes input based on current build mode and user actions.

_get_lazy_building_instantiator

1

_get_lazy_building_instantiator() -> BuildingInstantiator

Flags: private

Private lazy getter for building instantiator. Creates and configures the instantiator if it doesn’t exist.

return: BuildingInstantiator - The building instantiator instance

_get_lazy_preview_builder

1

_get_lazy_preview_builder() -> PreviewBuilder

Flags: private

Private lazy getter for preview builder. Creates and configures the preview builder if it doesn’t exist.

return: PreviewBuilder - The preview builder instance

_try_setup

1
2
3
4
5

_try_setup(
    p_preview_instance : Node,
    p_placeable_rules : Array[PlacementRule],
    p_ignore_base_rules: bool = false
) -> PlacementReport

Flags: private

_build_instance

1
2
3
4

_build_instance(
    p_placeable : Placeable,
    p_attach_placeable_instance : bool
) -> Node2D

Flags: private

Places the buildable scene into the world. Instantiates and places the buildable scene into the world at the preview location. Attaches PlaceableInstance if required and applies placement rules.

p_placeable: Placeable - Placeable resource to build

p_attach_placeable_instance: bool - Whether to attach PlaceableInstance component

_validate_build_ready

1

_validate_build_ready() -> bool

Flags: private

Validates if the building system is ready for placement.

_align_preview_to_grid

1

_align_preview_to_grid(collision_shape_global_position: Vector2) -> void

Flags: private

Aligns preview to the grid system. Aligns the preview instance to the grid system based on the given global position. Used to snap preview to grid tiles for accurate placement feedback.

_on_mode_changed

1

_on_mode_changed(p_mode: GBEnums.Mode) -> void

Flags: private

Handles changes to build mode. Cleans up build state and indicators when switching out of build mode. Resets the _cleaning_up guard for non-exit_build_mode mode-change paths.

Grid Building v5.0.8 | Generated 24/05/2026