Skip to content
Grid Building Docs

GBCompositionContainer

Summary

Section titled “Summary”

Dependency injection root for context-specific GridBuilder setup.

Creates unique configurations per player/character instance. Provides centralized access to all grid building dependencies.

Properties

Section titled “Properties”
config: GBConfig

Main configuration resource for the grid building system.

Methods

Section titled “Methods”
get_contexts( ) -> GBContexts

Cached contexts instance for dependency resolution.

Cached states instance for system coordination.

Cached logger instance for debugging and warnings.

Gets or creates the contexts container for dependency injection.

return: GBContexts - Contexts container with all system contexts

get_states( ) -> GBStates

Gets or creates the states container for all system states.

return: GBStates - States container with targeting, building, manipulation states

get_logger( ) -> GBLogger

Gets or creates the centralized logger instance.

return: GBLogger - Logger instance for error/warning reporting

get_mode_state( ) -> ModeState

Gets the mode state from the states container.

get_targeting_state( ) -> GridTargetingState

Gets the grid targeting state from the states container.

get_building_state( ) -> BuildingState

Gets the building state from the states container.

get_manipulation_state( ) -> ManipulationState

Gets the manipulation state from the states container.

get_settings( ) -> GBSettings

Gets the main settings configuration resource.

get_placement_rules( ) -> Array[PlacementRule]

Gets the placement rules array from settings.

get_visual_settings( ) -> GBVisualSettings

Gets the visual settings from the main settings.

get_systems_context( ) -> GBSystemsContext

Gets the systems context from the contexts container.

get_manipulation_settings( ) -> ManipulationSettings

Gets the manipulation settings from the main settings.

get_messages( ) -> GBMessages

Gets the messages configuration resource.

get_runtime_checks( ) -> GBRuntimeChecks

Gets the runtime checks configuration resource.

get_templates( ) -> GBTemplates

Gets the templates resource from configuration.

get_indicator_context( ) -> IndicatorContext

Gets the placement context from the contexts container.

get_actions( ) -> GBActions

Gets the input actions configuration resource.

get_name_displayer( ) -> NameDisplayer

Gets the name displayer configuration for UI display.

get_debug_settings( ) -> GBDebugSettings

Gets the debug settings from the main settings configuration.

get_editor_issues( ) -> Array[String]
get_runtime_issues( ) -> Array[String]

Gets all issues that would prevent the grid building systems from operating. This should be called after your level is loaded with GBLevelContext and a GBOwner is set to the GBOwnerContext

validate_editor( ) -> bool

Runs validation checks on editor setup to ensure required resources are set

validate_runtime( ) -> bool

Source

Section titled “Source”

addons/grid_building/resources/gb_composition_container.gd

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

Generated on 2025-09-07