Dt192: /* Examples */

2024-01-19T02:09:26Z

Examples

Zooka: initial creation

2024-01-18T23:10:58Z

initial creation

New page

[[Category:Mudlet Package Listing]]
{| class="wikitable" style="width: 70%;"
|-
| style="width: 10%" | Game || non-mud specific
|-
| By ||  Keegan Wantz
|-
| Download ||  [https://github.com/Kairuni/MudletLogger Github]
|-
| Dependencies ||  Mudlet 4.17
|}

= Description =


Loggers for Mudlet, for those times when you also want to log things that you don't explicitly see.

= Usage =

* <code>Logger.createLogger(filename, options)</code> - Creates a new logger for a given filename with the given options. Where options are:

::<code>timestamp = true | false (default: true)</code> - This uses Mudlet's timestamp, rather than capturing per-line.

::<code>maxFilesize = 1+ (default: infinite)</code> - This is the max filesize in kilobytes. Please make this a reasonable number (probably > 5000 for 5 mb filesize), or you will have a million tiny log files before very long.

::<code>keepOpen = true | false (default: true)</code> - Not sure this is actually necessary.

::<code>format = "html" | "ans" | "txt" (default: "html")</code> - I don't think this is slow enough to fake an enum vs. just using the string.

::<code>logAllSends = true | false (default: false)</code> - This can result in double logging of inputs, but will catch send("...", false).

* <code>myLogger:start()</code> - Begins logging from the current point in time. Creates a new log file if necessary, otherwise reopens the existing log file.

* <code>myLogger:stop()</code> - Stops logging at the current point in time, and closes the log file.

* <code>myLogger:log(str)</code> - Logs a string to the current logger, separate from game output.

* <code>Logger:buildTooltip(displayText, tooltipText, location)</code> - Builds a tooltip for HTML logs. Valid locations are left | right | top | bottom
::e.g. <code>myLogger:log(Logger:buildTooltip("This is a test tooltip.", "WEEOOWEEOO", "right"));</code>

See also:  [https://github.com/Kairuni/MudletLogger Github]

= Examples =



'''Alias : <code>^startCombatLog$</code>'''

<pre>
if (not combatLogger) then
combatLogger = Logger.createLogger("MyPKLog", {
timestamp = true,
keepOpen = true,
format = "html",
logAllSends = true,
maxFilesize = 1024
});
end

combatLogger:start();
</pre>

'''Trigger : On Prompt'''

<code>combatLogger:log(string.format("My current blood: %d</b>Am I paralyzed? %s", gmcp.Char.Vitals.blood, myAffs.paralysis and "Yes" or "No"));</code>

'''Alias : ^stopCombatLog$'''

<code>combatLogger:stop();</code>

@@ Line 50: / Line 50: @@
 '''Alias : <code>^startCombatLog$</code>'''
-<pre>
+<syntaxhighlight lang="lua">
 if (not combatLogger) then
      combatLogger = Logger.createLogger("MyPKLog", {
@@ Line 62: / Line 62: @@
 combatLogger:start();
-</pre>
+</syntaxhighlight>

Mudet logger package - Revision history

Dt192: /* Examples */

Zooka: initial creation