GBDebugSettings

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

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

Source File: addons/grid_building/debug/gb_debug_settings.gd

Extends: GBResource

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)

Exported Properties

  • Property: level: LogLevel = LogLevel.WARNING:

  • Property: grid_positioner_log_mode: GridPositionerLogMode = GridPositionerLogMode.NONE:

  • Property: draw_rule_check_indicator_debug: bool = false - Enable or disable drawing of RuleCheckIndicator debug overlays.

  • Property: 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.

  • Property: indicator_collision_point_scale: float = 0.15 - Scale factor applied to collision point radius based on the indicator’s grid size.

  • Property: indicator_connection_line_min_width: float = 1.0 - Minimum pixel width used when drawing connection lines for indicators.

  • Property: indicator_connection_line_scale: float = 0.05 - Scale factor applied to connection line width based on the indicator’s grid size.

  • Property: indicator_collision_point_color: Color = Color.RED - Color used to draw collision points (default: red).

  • Property: indicator_connection_line_color: Color = Color.ORANGE - Color for helper connection lines (default: orange).

  • Property: indicator_outline_color: Color = Color.WHITE - Outline color used when drawing indicator shapes (default: white).

Private Properties

  • Property: _level_internal: LogLevel = LogLevel.WARNING (private)

    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.

  • Property: _grid_positioner_log_mode_internal: GridPositionerLogMode = GridPositionerLogMode.NONE (private)

Public Methods

set_debug_level

1

set_debug_level(value: LogLevel) -> void

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

get_editor_issues

1

get_editor_issues() -> Array[String]

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

get_runtime_issues

1

get_runtime_issues() -> Array[String]

Get any runtime issues detected for this resource.

Private Methods

_init

1
2
3
4

_init(
    p_default_level := LogLevel.WARNING,
    p_default_positioner_mode := GridPositionerLogMode.NONE
) -> void

Flags: private