OpenUserLog - Debug
Revision as of 16:43, 22 January 2012 by imported>Qazaaq (added notes on log cycling and multiple plugins)
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 globalParameters
- asLogName: The name of the log to open, case-insensitive. User log names may use any combination of letters, numbers, spaces, 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")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.