Skip to content
Grid Building Docs

GBDebugSettings

Summary

Section titled “Summary”

Debug settings for logging and debugging output. Includes settings for visual debugging as well such as RuleCheckIndicator debug _draw calls to the screen. :::note[Note] Feature-specific logging toggles (e.g., GridPositioner2D logging flags) still only produce output when the GBLogger level is set to VERBOSE or higher. :::

Enums

Section titled “Enums”
enum LogLevel

The message verbosity level for plugin logging typically handeled through GBLogger objects resolved through the GBCompositionContainer.

  • NONE = 0 — No logging emitted from the plugin. Not recommended because this will hide real problems.
  • ERROR = 1 — Log only error conditions that require attention
  • WARNING = 2 — Log recoverable issues and unexpected states. Recommended level for games in production.
  • INFO = 3 — High-level state transitions and important lifecycle events
  • DEBUG = 4 — Developer-focused debugging information (objects, params)
  • VERBOSE = 5 — Very detailed, multi-line diagnostic output
  • TRACE = 6 — Extremely fine-grained tracing useful for step-by-step flow analysis
enum GridPositionerLogMode

Centralized logging control for GridPositioner2D diagnostics. Select exactly one mode at a time.

  • NONE = 0 — Disable GridPositioner2D diagnostics
  • VISIBILITY = 1 — Visibility decisions, visual state, end-of-frame summaries
  • MOUSE_INPUT = 2 — Mouse input gating, projection, and screen/tile context
  • POSITIONING = 3 — Tile movement, recenter decisions, and related positioning helpers
  • STATE_FLOW = 4 — Lifecycle events: dependency resolution, input toggles, mode changes, physics tick, deprecated APIs

Signals

Section titled “Signals”
signal debug_level_changed( new_level: int )

Emitted when the debug level changes to a new value

signal grid_positioner_log_mode_changed( new_mode: int )

Properties

Section titled “Properties”
level: LogLevel = LogLevel.WARNING

Global plugin log level. Keep a private backing field only for this property so we can emit debug_level_changed when the level changes at runtime.

grid_positioner_log_mode: GridPositionerLogMode = GridPositionerLogMode.NONE
draw_rule_check_indicator_debug: bool = false

Enable or disable drawing of RuleCheckIndicator debug overlays.

indicator_collision_point_min_radius: float = 2.0

RuleCheckIndicator visual tuning exposed in debug settings so teams can centrally adjust debug overlays without editing code.

Minimum pixel radius used when drawing collision points for indicators.

indicator_collision_point_scale: float = 0.15

Scale factor applied to collision point radius based on the indicator’s grid size.

indicator_connection_line_min_width: float = 1.0

Minimum pixel width used when drawing connection lines for indicators.

indicator_connection_line_scale: float = 0.05

Scale factor applied to connection line width based on the indicator’s grid size.

indicator_collision_point_color: Color = Color.RED

Color used to draw collision points (default: red).

indicator_connection_line_color: Color = Color.ORANGE

Color for helper connection lines (default: orange).

indicator_outline_color: Color = Color.WHITE

Outline color used when drawing indicator shapes (default: white).

Methods

Section titled “Methods”
func _init( p_default_level, p_default_positioner_mode )
func set_debug_level( value: LogLevel ) -> void

Change the LogLevel to the passed value. Emits the debug_level_changed signal if the level changes.

func get_editor_issues( ) -> Array[String]

Get any issues detected in the editor context for this resource.

func get_runtime_issues( ) -> Array[String]

Get any runtime issues detected for this resource.

Source

Section titled “Source”

addons/grid_building/debug/gb_debug_settings.gd

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