1

Description

"This is meant to be able to easy log certain things while developing. I started creating it because i needed some logging for a pathfinding. Step debugging was not feasible. And if i was working on something else i did not want the logging of the path finding. It uses bitwise operators but is easy extendable. Every new option is double the last one, and don't forget to add it to all.\r\n\r\nThe logger should be autoloaded. After configuring it as explained in the code below you can call it from any place like \r\n\r\n```\r\n\r\nvar log\r\n\r\nfunc _ready() -> void: \r\n\tlog = get_node(\"\/root\/Log\")\r\n\tpass\r\n\r\nlogger.log_error(\"Scene index not found: \" + str(scene), logger.LogType.LOG_SCENE)\r\nlogger.log_info(\"Scene started: \" + str(scene), log.LogType.LOG_SIGNAL)\r\n```\r\n\r\nAll code is on github as part of my godot 4 starter"

Screenshots

Main code

# Put this in a main.gd (or wherever you want, its to configure the log levels from your parent scene)
var Logger := load("res://src/managers/log.gd")
@export_flags("LOG_ERROR","LOG_WARN", "LOG_INFO", "LOG_DEBUG") var log_level: int = Logger.LogSeverity.LOG_NONE
@export_flags("LOG_GENERAL","LOG_UI", "LOG_ENEMY", "LOG_PLAYER", "LOG_SIGNAL", "LOG_PATHFINDING", "LOG_INIT", "LOG_EXIT", "LOG_SCENE", "LOG_SOUND", "LOG_STATE") var log_type: int = Logger.LogType.LOG_GENERAL

var log

func _ready() -> void:
	self.log = get_node("/root/Log")
	self.log.init(self.log_level, self.log_type)


Put this wherevere you want in this example its src/managers/log.gd
extends Node

enum LogSeverity {
	LOG_NONE = 0,
	LOG_ERROR = 1,
	LOG_WARN = 2,
	LOG_INFO = 4,
	LOG_DEBUG = 8,
	LOG_ALL = 8 + 4 + 2 + 1
};

enum LogType {
	LOG_GENERAL = 1,
	LOG_UI = 2,
	LOG_ENEMY = 4,
	LOG_PLAYER = 8,
	LOG_SIGNAL = 16,
	LOG_PATHFINDING = 32,
	LOG_INIT = 64,
	LOG_EXIT = 128,
	LOG_SCENE = 256,
	LOG_SOUNDS = 512,
	LOG_STATE = 1024,
	LOG_ALL = 1024 + 512 + 256 + 128 + 64 + 32 + 16 + 8 + 4 + 2 + 1
};

var log_severity = LogSeverity.LOG_ALL
var log_type = LogType.LOG_ALL

func init(log_level, log_type):
	self.log_severity = log_level
	self.log_type = log_type

# Get the severity name based on the severity value
func get_severity_name(severity):
	match severity:

		LogSeverity.LOG_ERROR:
			return "ERROR"
		LogSeverity.LOG_WARN:
			return "WARNING"
		LogSeverity.LOG_INFO:
			return "INFORMATION"
		LogSeverity.LOG_DEBUG:
			return "DEBUG"
		LogSeverity.LOG_ALL:
			return "ALL LOGS"
		_:
			return "NONE"
	

	# Get the type name based	on the type value
func get_type_name(type): 
	match type:
		LogType.LOG_UI:
			return "Ui"
		LogType.LOG_ENEMY:
			return "Enemy"
		LogType.LOG_PLAYER:
			return "Player"
		LogType.LOG_SIGNAL:
			return "Signal"
		LogType.LOG_PATHFINDING:
			return "Pathfinding"
		LogType.LOG_INIT:
			return "Init"
		LogType.LOG_EXIT:
			return "Exit"
		LogType.LOG_SCENE:
			return "Scenes"
		LogType.LOG_SOUNDS:
			return "Sounds & Music"
		LogType.LOG_STATE:
			return "State Machine"
		LogType.LOG_ALL:
			return "All types"
		_:
			return "NONE"

func log_error(message: String, type:=LogType.LOG_GENERAL):
	if self.log_type & type:
		self.print_log(message, LogSeverity.LOG_ERROR, type)

func log_warning(message: String, type:=LogType.LOG_GENERAL):
	if self.log_type & type:
		self.print_log(message, LogSeverity.LOG_WARN, type)

func log_info(message: String, type:=LogType.LOG_GENERAL):
	if self.log_type & type:
		self.print_log(message, LogSeverity.LOG_INFO, type)

func log_debug(message: String, type:=LogType.LOG_GENERAL):
	if self.log_type & type:
		self.print_log(message, LogSeverity.LOG_DEBUG, type)

func print_log(message:String, severity:=LogSeverity.LOG_ERROR, type:=LogType.LOG_GENERAL):
		if self.log_severity & severity && self.log_type & type:
			print(get_severity_name(severity) , "(", get_type_name(type) , "): ", message)

Comments