aboutsummaryrefslogtreecommitdiff
path: root/gamemode/shared/log.lua
diff options
context:
space:
mode:
authorAlexander M Pickering <alex@cogarr.net>2025-12-27 17:21:49 -0600
committerAlexander M Pickering <alex@cogarr.net>2025-12-27 17:21:49 -0600
commit0c6a674999333a10317ee8a2b43f72bde03068c5 (patch)
tree71e1839fafaba516d2472d02847fe65d469a5550 /gamemode/shared/log.lua
parentaacf5fbcfe1e6f2cdb0c6ab19b3e8dd87e3fd488 (diff)
downloadartery-master.tar.gz
artery-master.tar.bz2
artery-master.zip
Update for documentationHEADmaster
Diffstat (limited to 'gamemode/shared/log.lua')
-rw-r--r--gamemode/shared/log.lua20
1 files changed, 20 insertions, 0 deletions
diff --git a/gamemode/shared/log.lua b/gamemode/shared/log.lua
index 5fc043f..480cde2 100644
--- a/gamemode/shared/log.lua
+++ b/gamemode/shared/log.lua
@@ -14,18 +14,38 @@ elseif CLIENT then
end
local log_levels = {
+ --- Debugging messages.
+ -- Prints out messages for debugging, each parameter will have `tostring()`
+ -- called on it, interleaved with spaces and with `[DEBUG]` prepended to the whole string.
+ --@function debug(...)
+ --@param ... values to print
debug = {
color = col.console.gray,domain,
prefix = "[DEBUG]"
},
+ --- Informational messages.
+ -- Prints out messages, each parameter will have `tostring()`
+ -- called on it, interleaved with spaces and with `[INFO]` prepended to the whole string.
+ --@function info(...)
+ --@param ... values that will have `tostring()` called on them, prefixed with `[INFO]` and interleaved with spaces.
info = {
color = col.console.cyan,domain,
prefix = "[INFO]",
},
+ --- Warning messages.
+ -- Prints out warning messages, each parameter will have `tostring()`
+ -- called on it, interleaved with spaces and with `[WARN]` prepended to the whole string.
+ --@function warn(...)
+ --@param ... values that will have `tostring()` called on them, prefixed with `[WARN]` and interleaved with spaces.
warn = {
color = col.console.yellow,domain,
prefix = "[WARNING]",
},
+ --- Error messages.
+ -- Prints out warning messages, each parameter will have `tostring()`
+ -- called on it, interleaved with spaces and with `[ERROR]` prepended to the whole string.
+ --@function error(...)
+ --@param ... values that will have `tostring()` called on them, prefixed with `[ERROR]` and interleaved with spaces.
error = {
color = col.console.red,domain,
prefix = "[ERROR]",