atiran/porymap
3
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add new functions to manual's 'Utility Functions' section

Browse source
This commit is contained in:
GriffinR 2021-12-14 23:40:33 -05:00 committed by huderlem
parent 80010ee131
commit c0769a5e80
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docsrc/manual/scripting-capabilities.rst
View file

@ -607,6 +607,19 @@ These are some miscellaneous functions that can be very useful when building cus
.. js:function:: map.log(message)
Logs a message to the Porymap log file. This is useful for debugging custom scripts.
Logs a message to the Porymap log file with the prefix ``[INFO]``. This is useful for debugging custom scripts.
:param string message: the message to log
.. js:function:: map.warn(message)
Logs a message to the Porymap log file with the prefix ``[WARN]``.
:param string message: the message to log
.. js:function:: map.error(message)
Logs a message to the Porymap log file with the prefix ``[ERROR]``.
:param string message: the message to log