log.debug: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=log.debug |trusted=true |version=1.5.2 |description= Writes a message to the log at the DEBUG logging level. |usage= <source lang="mtmacro" line> log.de...")
 
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:
|version=1.5.2
|version=1.5.2
|description=
|description=
Writes a message to the log at the DEBUG logging level.
Writes a message to the log at the DEBUG logging level. Use {{func|log.setLevel}} to set the appropriate level for the {{code|macro-logger}}.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
log.debug(message)
log.debug(message)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|message|A string containing the message to be logged.}}
{{param|message|A string containing the message to be logged.}}
Line 16: Line 16:
Output a message to the {{code|macro-logger}} at the DEBUG level.
Output a message to the {{code|macro-logger}} at the DEBUG level.


<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: log.debug("Switched to map " + getCurrentMapName())]
[h: log.debug("Switched to map " + getCurrentMapName())]
</source>
</syntaxhighlight>
'''Returns:'''
'''Returns:'''


Empty string to calling macro.  Output is in log file.
Empty string to calling macro.  Output is in log file.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
2019-04-19 08:52:18.853 [AWT-EventQueue-0] DEBUG macro-logger - Switched to map Pit of Despair
1987-09-25 08:52:18.853 [AWT-EventQueue-0] DEBUG macro-logger - Switched to map Pit of Despair
</source>
</syntaxhighlight>
|also=
|also=
[[log.getLoggers|log.getLoggers]] [[log.setLevel|log.setLevel]]
{{func|log.getLoggers}} {{func|log.setLevel}}


}}
}}
[[Category:Log Function]]
[[Category:Log Function]]

Latest revision as of 20:12, 15 March 2023

log.debug() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.2
Writes a message to the log at the DEBUG logging level. Use log.setLevel() to set the appropriate level for the macro-logger.

Usage

log.debug(message)

Parameters

  • message - A string containing the message to be logged.

Example

Output a message to the macro-logger at the DEBUG level.
[h: log.debug("Switched to map " + getCurrentMapName())]

Returns:

Empty string to calling macro. Output is in log file.

1987-09-25 08:52:18.853 [AWT-EventQueue-0] DEBUG macro-logger - Switched to map Pit of Despair

See Also