Skip to content
Grid Building Docs

GBActionLog

Summary

Section titled “Summary”

Shows recent messages from the grid building plugin actions within the context of the GBCompositionContainer scope

Properties

Section titled “Properties”
message_log: RichTextLabel

Visual output area for where messages go when output from the build log

Methods

Section titled “Methods”
func _disconnect_building_state( ) -> void

Build log settings injected from centralized configuration (private)

DRY helper: Disconnect building state signals

func _connect_building_state( ) -> void

DRY helper: Connect building state signals

func _disconnect_manipulation_state( ) -> void

DRY helper: Disconnect manipulation state signals

func _connect_manipulation_state( ) -> void

DRY helper: Connect manipulation state signals

func _disconnect_mode_state( ) -> void

DRY helper: Disconnect mode state signals

func _connect_mode_state( ) -> void

DRY helper: Connect mode state signals

func _ready( )
func resolve_gb_dependencies( p_container: GBCompositionContainer ) -> void
func clear_log( )
func get_settings( ) -> ActionLogSettings

Lazy initialization for settings - only creates defaults if not injected Public getter for testing and external access

func validate_setup( ) -> bool

Validates that all required dependencies are present

func append_validation_results( p_results: ValidationResults )

Adds validation results to the log as settings request.

func append_placement_report_issues( p_report: PlacementReport ) -> void

DRY helper: Adds placement report issues to the log

func _append_issues_list( issues: Array[String] ) -> void

DRY helper: Appends a list of issue strings to the message log

func append_manipulation( p_data: ManipulationData )
func should_show( p_action: GBEnums.Action ) -> bool

Checks whether the action data should show in the log or not.

func _print_reasons( p_rule_results: Dictionary[PlacementRule, RuleResult], p_failed_only: bool )

Prints the reasons for each rule result to the message log. p_failed_only: bool - Whether to print only failed results (default true)

func _get_display_name_safe( obj: Node ) -> String

DRY helper: Determines display name for objects with fallback

func _handle_build_result( p_data: BuildActionData, is_success: bool ) -> void

DRY helper: Handles color and message formatting for build results

func _on_build_success( p_data: BuildActionData ) -> void
func _on_build_failed( p_data: BuildActionData ) -> void
func _handle_manipulation_result( p_data: ManipulationData, is_finished: bool ) -> void

DRY helper: Handles manipulation result display with consistent color coding

func _on_manipulation_started( p_data: ManipulationData ) -> void
func _on_manipulation_failed( p_data: ManipulationData )
func _on_manipulation_finished( p_data: ManipulationData )
func _on_mode_changed( p_mode: GBEnums.Mode ) -> void

Handles mode change events and outputs to action log if enabled

Source

Section titled “Source”

addons/grid_building/ui/actions/gb_action_log.gd

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