OpenUserLog - Debug

From Creation Kit
Jump to: navigation, search

Member of: Debug Script

Opens a new user log on disk. This will also cycle the older logs (so log 0 becomes 1, 1 becomes 2, etc). The log files are stored in "My Documents/My Games/Skyrim/Logs/Script/User". If the log is already open, the function will return false (but not print an error to the main script log). Note that you do not have to close the log yourself unless you want to, it will close automatically when the game ends, the player goes back to the main menu, or a save is loaded.

Syntax

bool Function OpenUserLog(string asLogName) native global

Parameters

  • asLogName: The name of the log to open, case-insensitive. User log names may use any combination of letters, numbers, and underscores ("_").

Return Value

True if the log was successfully opened. False if the name was invalid, or the log was already open.

Examples

; Opens a new user log name "myUserLog"
Debug.OpenUserLog("myUserLog")
 
; Outputs "Hello World" to the "myUserLog" log
Debug.TraceUser("myUserLog", "Hello World")

Notes

  • A new log file is created each game session (a session ends when the game is no longer running).
  • Multiple scripts and plugins can write to the same logfile.

See Also