From d26f16e1df328db68eb5097bebf57fddb78fc4ae Mon Sep 17 00:00:00 2001 From: Mateusz Uczciwek Date: Sun, 29 Oct 2023 11:49:49 +0100 Subject: [PATCH] [Ikarus] change the name of `preamble` to `debug` --- .../extenders/ikarus/functions/{preamble.md => debug.md} | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) rename docs/zengin/scripts/extenders/ikarus/functions/{preamble.md => debug.md} (90%) diff --git a/docs/zengin/scripts/extenders/ikarus/functions/preamble.md b/docs/zengin/scripts/extenders/ikarus/functions/debug.md similarity index 90% rename from docs/zengin/scripts/extenders/ikarus/functions/preamble.md rename to docs/zengin/scripts/extenders/ikarus/functions/debug.md index 12ace22c36..80e948e7e2 100644 --- a/docs/zengin/scripts/extenders/ikarus/functions/preamble.md +++ b/docs/zengin/scripts/extenders/ikarus/functions/debug.md @@ -1,5 +1,5 @@ -# Preamble -The preamble is a bunch of functions related with debug and some stuff, that doesn't fit to other sections. +# Debug +A set of debugging and error-handling functions for mod development with Ikarus. ## Initialization The best way to initialize all Ikarus functions is to call `MEM_InitAll()` in the `Init_Global()` initialization function. @@ -11,7 +11,7 @@ MEM_InitAll(); ``` ## Implementation -[:material-github: Ikarus.d on GitHub](https://github.com/Lehona/Ikarus/blob/master/Ikarus.d#L137) +[:material-github: Ikarus.d on GitHub](https://github.com/Lehona/Ikarus/blob/master/Ikarus.d#L135-L327) ## Functions @@ -102,7 +102,7 @@ func void MEM_AssertFail(var string assertFailText) The assertion failure message. ### `MEM_Debug` -Sends a debug message to the zSpy or on screen or displays an error box basing on `zERR_DEBUG_TOSPY`, `zERR_DEBUG_TOSCREEN` and `zERR_DEBUG_ERRORBOX` constants (`TRUE` - display). +Freely conigurable debug chanell. See how to setup it in the [Constants](../constants.md#mem_debug) article. ```dae func void MEM_Debug(var string message) ```