It may be better to mention that messages are output to the in-game chat...

...too (INFO, WARNING, ERROR and DEBUG documentation).
This commit is contained in:
Ignacio R. Morelle 2009-01-12 18:36:10 +00:00
parent dd5263ee23
commit 8ff15e743c

View file

@ -444,9 +444,10 @@
#enddef
#define DEBUG TEXT
# Logs a debug message to console. It does nothing unless the 'wml'
# log domain is set to debug level at application startup (usually with
# --log-debug=wml), or in-game with the :log command (e.g. :log debug wml).
# Logs a WML debug message to consol and the in-game chat.
# It does nothing unless the 'wml' log domain is set to debug
# level at application startup (usually with --log-debug=wml),
# or in-game with the :log command (e.g. :log debug wml).
#
# Example:
# ! {DEBUG "inconsistency: $unit.id is not loyal!"}
@ -457,9 +458,10 @@
#enddef
#define LOG TEXT
# Logs a message to console. It does nothing unless the 'wml'
# log domain is set to log level at application startup (usually with
# --log-info=wml), or in-game with the :log command (e.g. :log info wml).
# Logs a WML message to console and the in-game chat. It does
# nothing unless the 'wml' log domain is set to log level at
# application startup (usually with --log-info=wml), or in-game
# with the :log command (e.g. :log info wml).
#
# Example:
# ! {LOG "player moved to forbidden location"}
@ -470,9 +472,10 @@
#enddef
#define WARNING TEXT
# Logs a warning to console. It does nothing unless the 'wml'
# log domain is set to warning level at application startup (usually with
# --log-warning=wml), or in-game with the :log command (e.g. :log warning wml).
# Logs a WML warning to console and the in-game chat. It does
# nothing unless the 'wml' log domain is set to warning level at
# application startup (usually with --log-warning=wml), or in-game
# with the :log command (e.g. :log warning wml).
#
# Example:
# ! {WARNING "malformed unit data"}
@ -483,7 +486,7 @@
#enddef
#define ERROR TEXT
# Logs an error to console.
# Logs a WML error to console and the in-game chat.
#
# Example:
# ! {ERROR "could not respawn hero at 2,4"}