Background for Skyrim SE
Member of the Debug script
boolfunctionOpenUserLog(stringasLogName)NativeGlobal

Description

Wiki Description

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.

Documentation Comment

Opens a user log - fails if the log is already open


Caveats

CK Wiki - 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.

Parameters

  1. stringasLogName

    CK Wiki Description

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


Examples

; Opens a new user log name "myUserLog"
Debug.OpenUserLog("myUserLog")

; Outputs "Hello World" to the "myUserLog" log
Debug.TraceUser("myUserLog", "Hello World")

Auto-Generated Example

string myString__asLogName

bool returnedValue = Debug.OpenUserLog(myString__asLogName)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.