RegisterLog

A command for ConScribe.

Syntax:

(result:int) RegisterLog formatString:string var1 var2 ... var20 defaultFlag:bool

Registers a log name with the calling mod. If the default flag is set, it's registered as the mod's default log. Returns -1 if the call was unsuccessful.

Notes

• The log name shouldn't contain any reserved characters ( /, \, <, >, *, :, ?, ", |, ; ). The command will not register invalid log names.
• The file extension (.log) is appended to the filename.
• Registered log names are saved with the game save.
• RegisterLog will fail if there already exists a registered log of the same name.

Example

begin gameMode
   scribe "This will be printed to the script log" 1
   registerLog "ConScribe Log %g" gameDaysPassed 1   ;default log

   scribe "This will be printed to the registered log" 1
   registerLog "Log B"
   scribe "This will be printed to Log B|Log B" 1
end

See also

Scribe
UnregisterLog