Skip to content
Grid Building Docs

GridPositioner2D

Summary

Section titled “Summary”

Controls the position for interactions on the building system and selects targets from objects under the positioner ShapeCast2D for the BuildingState

Required on a per composition container basis

Properties

Section titled “Properties”
mouse_handled = true

Logger injected from composition container for verbose/debug output

The state pf the BuildingSystem holding a reference to this positioner.

Methods

Section titled “Methods”
_ready( )
resolve_gb_dependencies( p_config: GBCompositionContainer ) -> void
remove_self_as_positioner( )

Removes this object from being set to the _targeting_state.positioner property

update_visibility( )

Remove self from being the state positioner

Uses whether the mouse movement was consumed by UI to determine if the positioner and child objects should be visible or invisible. Only called when hide_on_handled is true

set_dependencies( p_states: GBStates, config: GBConfig )

Dependency injection function

get_runtime_issues( ) -> Array[String]

Checks if the properties of the GridPositioner2D are set properly during gameplay. Returns validation issues if dependencies are missing, empty array if valid.

return: Array[String] - List of validation issues (empty if valid)

Source

Section titled “Source”

addons/grid_building/systems/grid_targeting/grid_positioner/grid_positioner_2d.gd

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

Generated on 2025-09-07