Differences

This shows you the differences between two versions of the page.

--- mod-functions:log [2019/05/29 13:38] – external edit 127.0.0.1
+++ mod-functions:log [2020/05/06 16:22] (current) – removed maxime
@@ Line 1: / Line 1: @@
-====== Logging functions ======
-===== log =====
-Creates an ''INFO'' entry in the mod's log file
-<code lua>
-myMod:log(logContent)
-</code>
-Parameters:
-  * ''logContent'' (string): the content of the log entry to create
-----
-===== logWarning =====
-Creates a ''WARNING'' entry in the mod's log file
-<code lua>
-myMod:logWarning(logContent)
-</code>
-Parameters:
-  * ''logContent'' (string): the content of the log entry to create
-----
-===== logError =====
-Creates an ''ERROR'' entry in the mod's log file
-<code lua>
-myMod:logError(logContent)
-</code>
-Parameters:
-  * ''logContent'' (string): the content of the log entry to create
-----
-===== msgBox =====
-Creates a modal message box to display a message to the player. This function is recommended for mod development only.
-For this function to work, the user must manually set the field ''ModMsgBoxEnabled'' to ''true'' in the user settings file (''usersetting.config''). Otherwise, it will only create a new log entry, like the ''log'' function.
-<code lua>
-myMod:msgBox(msgBoxContent)
-</code>
-Parameters:
-  * ''msgBoxContent'' (string): the content displayed in the message box