Skip to content

Class

PlacementLogger

Generated GDScript class reference for GridPlacement.PlacementLogger.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Centralized logging for the Grid Building plugin. Prefer the static singleton API; it needs no null checks: [codeblock] PlacementLogger.initialize(debug_settings) # once at plugin init PlacementLogger.push_scope(custom_logger) # optional scoped override PlacementLogger.pop_scope() PlacementLogger.debug("msg") PlacementLogger.warn("msg") [/codeblock] [method initialize] replaces the production root. For bounded overrides (one test, one sub-region) use [method push_scope] / [method pop_scope] so the override auto-cleans on exit. Tests push a muted or spy logger in before_test and pop it in after_test. The instance API ([code]logger.log_debug("msg")[/code]) remains for compatibility.

Source: addons/grid_placement/logging/placement_logger.gd

Syntax

class PlacementLogger extends RefCounted

Members

NameKindSummary
push_scopeMethod
pop_scopeMethod
set_instanceMethod
clear_instanceMethod
initializeMethod
LogLevelFieldShorthand level alias for callsites.
debugMethod
traceMethod
trace_output_enabledMethod
infoMethod
warnMethod
errorMethod
verboseMethod
set_log_sinkMethod
log_atMethod
get_runtime_issuesMethod
resolve_placement_dependenciesMethod
is_level_enabledMethod
is_debug_enabledMethod
is_verbose_enabledMethod
is_trace_enabledMethod
log_warningMethod
log_infoMethod
log_errorMethod
log_verboseMethod
log_traceMethod
log_debugMethod
get_debug_settingsMethod