From d0e8e394fab89ba98cae2d05e7744c92f72fbaff Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Mon, 18 Mar 2024 03:03:54 +0100 Subject: [PATCH] Update CoreLoggerInstance --- src/classes/loggerinstance.gd | 35 +++++++++++++++++++++++++++++++---- src/logger.gd | 2 +- 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/src/classes/loggerinstance.gd b/src/classes/loggerinstance.gd index 7eb8723..78326b3 100644 --- a/src/classes/loggerinstance.gd +++ b/src/classes/loggerinstance.gd @@ -1,16 +1,43 @@ -extends Node +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +## Passes [code]origin[/code] for you. +## +## Pretty much a wrapper around CORE's logging implementation. +## CoreLoggerInstance's only job is to save you some effort aka. +## you not needing to pass the [code]origin[/code] argument to each +## and every log call, which is extremely annoying. Thank us later ;) +extends CoreBaseModule class_name CoreLoggerInstance -var logger: CoreBaseModule +## Class name var origin: String -func _init(logger_new: CoreBaseModule, origin_new: String) -> void: - logger = logger_new +func _init(origin_new: String) -> void: origin = origin_new +## Prints a diagnostic message func diag(message: String) -> void: logger.diag(origin, message) +## Prints a verbose message func verb(message: String) -> void: logger.verb(origin, message) +## Prints a informational message func info(message: String) -> void: logger.info(origin, message) +## Prints a warning message func warn(message: String) -> void: logger.warn(origin, message) +## Prints a error message func error(message: String) -> void: logger.error(origin, message) +## Handles crashes. Will terminate your game/application immediately. func crash(message: String) -> void: await logger.crash(origin, message) diff --git a/src/logger.gd b/src/logger.gd index af6e904..2de99b0 100644 --- a/src/logger.gd +++ b/src/logger.gd @@ -195,4 +195,4 @@ func errorf(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel func crashf(origin: String, message: String) -> void: crash(core.basepath.replace("res://", "") + "src/" + origin, message) # Returns a logger instance -func get_instance(origin: String) -> CoreLoggerInstance: return CoreLoggerInstance.new(self, origin) +func get_instance(origin: String) -> CoreLoggerInstance: return CoreLoggerInstance.new(origin)