Difference between revisions of "Reference:Debug.inc"

From POV-Wiki
Jump to navigation Jump to search
m (1 revision: Initial Load (TF))
 
m (1 revision: Reference Migration Initial Load)
 
(No difference)

Latest revision as of 19:05, 15 March 2012

This file contains a set of macros designed to make debugging easier. It also functions like the old debug.inc, with the exception that you have to call the Debug_Inc_Stack() macro to get the include stack output.

Debug_Inc_Stack(): Activates include file tracking, each included file will send a debug message when it is included.

Parameters:

  • None.

Set_Debug(Bool): Activate or deactivate the debugging macros.

Parameters:

  • Bool = A boolean (true/false) value.

Debug_Message(Str): If debugging, sends the message to the debug stream.

Parameters:

  • Str = The desired message.

Debug(Condition, Message): Sends a message to the #debug stream depending on a given condition.

Parameters:

  • Condition = Any boolean expression.
  • Message = The message to be sent if Condition evaluates as true.

Warning(Condition, Message): Sends a message to the #warning stream depending on a given condition.

Parameters:

  • Condition = Any boolean expression.
  • Message = The message to be sent if Condition evaluates as true.

Error(Condition, Message): Sends a message to the #error stream depending on a given condition.

Parameters:

  • Condition = Any boolean expression.
  • Message = The message to be sent if Condition evaluates as true.