TraceFunction - Debug

Member of: Debug Script

Outputs a string to the Papyrus log on disk, and the Papyrus overlay. It also attaches all available information about the function that called in, including the current value of all of the function's variables and parameters.

Syntax

Function TraceFunction(string asTextToPrint = "Tracing function on request", int aiSeverity = 0) native global debugOnly

Parameters

• asTextToPrint: The text that should be printed to the log and text page.
  • Default: "Tracing function on request"
• aiSeverity: The severity of the trace statement. Info, the default, will show up as green; warnings will show up as yellow; and errors as red; in the Papyrus debug text page.
  • Default: 0 (Info)
  • The following values are acceptable:
    • 0: Info
    • 1: Warning
    • 2: Error

Return Value

None

Examples

; Outputs "Tracing function on request" along with all available information about this function to the log
Debug.TraceFunction()

; Outputs "Tracing function on request" along with this function's information to the log, at error severity (colored red)
Debug.TraceFunction(aiSeverity = 2)

See Also

• Debug Script
• Trace - Debug