Module Debug

Functions for debugging.

Don't forget to remove/comment out your debug functions before publishing your script/plugin.

Usage:

    Debug.log('Hello World', 'Multiple arguments')
    Debug.toast('I am a toast')
    Debug.info('I am displayed in debug overlay')
    

Functions

log (message1[, message2[, message3[, ...]]]) Logs a message into the script internal log.
toast (message1[, message2[, message3[, ...]]]) Shows the specified message as toast overlay.
info (message1[, message2[, message3[, ...]]]) Logs a message into the debug overlay of the game.


Functions

log (message1[, message2[, message3[, ...]]])
Logs a message into the script internal log.

Parameters:

  • message1
  • message2 (optional)
  • message3 (optional)
  • ... (optional)
toast (message1[, message2[, message3[, ...]]])
Shows the specified message as toast overlay. It's discouraged to call this function too often since new messages are postponsed if a previous message is still displayed.

Parameters:

  • message1
  • message2 (optional)
  • message3 (optional)
  • ... (optional)
info (message1[, message2[, message3[, ...]]])
Logs a message into the debug overlay of the game. This function is meant to be used within the script:update() method since the log is cleared every frame. Calling this function opens the debug overlay automatically, so ensure to remove it in your production code.

Parameters:

  • message1
  • message2 (optional)
  • message3 (optional)
  • ... (optional)
generated by LDoc 1.4.3 Last updated 2019-10-28 15:18:26