Skip to content
Grid Building Docs

GBLogger

Summary

Section titled “Summary”

Centralized logging facility for the Grid Building plugin.

Responsibilities:

  • Provide contextual logging (verbose, error, warning) integrated with plugin debug settings.
  • Support dependency-injected configuration and throttled verbose output.

Methods

Section titled “Methods”
get_runtime_issues( ) -> Array[String]

Validates that debug settings have been injected. Returns list of validation issues (empty if valid).

resolve_gb_dependencies( p_config: GBCompositionContainer ) -> bool

Receives injected dependencies from the composition container. Assigns debug settings if available.

is_debug_enabled( ) -> bool

Returns true if verbose/debug logging is currently enabled.

is_verbose_enabled( ) -> bool

Returns true if verbose logging is currently enabled.

is_trace_enabled( ) -> bool

Returns true if trace logging is currently enabled (the most detailed level).

log_warning( p_sender: Object, p_issue: String ) -> void
log_info( p_sender: Object, p_message: String ) -> void

Logs an informational message (between WARNING and DEBUG levels) Only prints when debug level >= INFO

log_error( p_sender: Object, p_issue: String ) -> void

Logs an error message for the specified sender object.

p_sender: Object - Object that generated the error

p_issue: String - Error message to log

log_warnings( p_sender: Object, p_issues: Array[String] ) -> void

Logs multiple warning messages for the specified sender object.

p_sender: Object - Object that generated the warnings

p_issues: Array[String] - Array of warning messages to log

log_issues( p_sender: Object, p_issues: Array[String] ) -> void

Logs multiple issues as warnings (alias for log_warnings).

p_sender: Object - Object that generated the issues

p_issues: Array[String] - Array of issue messages to log as warnings

log_verbose( p_sender: Object, p_message: String ) -> void

Logs a verbose message for debugging purposes.

p_sender: Object - Object that generated the verbose message

p_message: String - Verbose message to log

log_trace( p_sender: Object, p_message: String ) -> void

Trace-level log for extremely detailed diagnostics (above VERBOSE)

log_debug( p_sender: Object, p_message: String ) -> void

Debug-level log helper (alias of verbose at VERBOSE level)

log_verbose_throttled( p_sender: Object, key: String, p_message: String ) -> void

Throttled verbose logging: prints at most every N ms per (sender,key)

log_debug_throttled( p_sender: Object, key: String, p_message: String ) -> void

Throttled debug helper (alias of verbose throttled)

log_trace_throttled( p_sender: Object, key: String, p_message: String ) -> void

Throttled trace helper

log_verbose_once( p_sender: Object, key: String, p_message: String ) -> void

Logs a verbose message only once per (sender,key). Useful to avoid per-frame spam.

log_debug_once( p_sender: Object, key: String, p_message: String ) -> void

Log a debug message only once per (sender,key)

log_trace_once( p_sender: Object, key: String, p_message: String ) -> void

Log a trace message only once per (sender,key)

get_debug_settings( ) -> GBDebugSettings

Gets the debug settings configuration resource.

Source

Section titled “Source”

addons/grid_building/logging/gb_logger.gd

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

Generated on 2025-09-07