Skip to content
Grid Building Docs

GBConfigurationValidator

Summary

Section titled “Summary”

Centralized validation system for GBCompositionContainer configuration.

Validates that all required dependencies and configurations are properly set up before systems start operating.

Methods

Section titled “Methods”
static func get_editor_issues( container: GBCompositionContainer ) -> Array[String]

Validates a GBCompositionContainer configuration. Returns list of validation issues (empty if valid). container: GBCompositionContainer - The container to validate

static func get_runtime_issues( container: GBCompositionContainer, p_checks: GBRuntimeChecks ) -> Array[String]

Validates runtime configuration (called after nodes are set up) container: GBCompositionContainer - The container to validate logger: GBLogger - The logger to use for logging issues p_checks: GBRuntimeChecks - The runtime checks to perform

static func _format_diagnostic_sections( sections: Dictionary, title: String, container: GBCompositionContainer, all_issues: Array ) -> String

Helper function to format diagnostic sections into human-readable output

static func editor_diagnostic( container: GBCompositionContainer ) -> String

Returns a human-readable, grouped diagnostic string for editor issues. This enumerates each main subresource (contexts, config, templates, actions, states) and prints the issues found for each one, including the resource path when available.

static func runtime_diagnostic( container: GBCompositionContainer, p_checks: GBRuntimeChecks ) -> String

Returns a human-readable, grouped diagnostic string for runtime issues. This enumerates each main subresource (contexts, config, templates, actions, states) and prints the issues found for each one, including the resource path when available.

static func validate_editor( container: GBCompositionContainer ) -> bool

Logs issues and returns whether no issues were found

static func validate_runtime( container: GBCompositionContainer ) -> bool

Highly recommended to call this deferred on ready for your main gameplay scene to allow all nodes to be properly added to the scene AND injected by the GBInjectorSystem before validation

Source

Section titled “Source”

addons/grid_building/validation/gb_configuration_validator.gd

This API reference is automatically generated from the plugin source code. For implementation examples and usage guides, see the guides section.