Difference between revisions of "Scribe"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Shademe
m
imported>Shademe
Line 21: Line 21:
==Notes==
==Notes==
* Script logs are created in the '''ConScribe Logs -> Per-Script''' folder. Logs names follow the convention: ''<Mod Name> - [XX]<Calling script's truncated formID>''.
* Script logs are created in the '''ConScribe Logs -> Per-Script''' folder. Logs names follow the convention: ''<Mod Name> - [XX]<Calling script's truncated formID>''.
  Registered logs are created in the '''ConScribe Logs -> Per-Mod''' folder.
<nowiki>    Registered logs are created in the '''ConScribe Logs -> Per-Mod''' folder.</nowiki>
* The calling mod must have a log registered to use scribe operation 1.
* The calling mod must have a log registered to use scribe operation 1.
* String variables can be passed using the '''%z''' format specifier.
* String variables can be passed using the '''%z''' format specifier.


==Example==
==Example==

Revision as of 20:58, 26 September 2009

A command for ConScribe.

Syntax:

(nothing) Scribe formatString:string var1 var2 ... var20 printToConsole:bool scribeOperation:integer

Primary output function. Prints output to a log file and, optionally, to the console.


Scribe Operation Integer
Post to Script Log 0
Post to Registered Log 1


Notes

  • Script logs are created in the ConScribe Logs -> Per-Script folder. Logs names follow the convention: <Mod Name> - [XX]<Calling script's truncated formID>.

    Registered logs are created in the '''ConScribe Logs -> Per-Mod''' folder.

  • The calling mod must have a log registered to use scribe operation 1.
  • String variables can be passed using the %z format specifier.

Example

string_var svLog

begin gameMode
   scribe "This will be printed to the Script log, but not to the console" 0
   scribe "This will be printed to the console alone" 1

   let svLog := "Con" + $player + "Scribe"
   scribe "String Var - %z" svLog 1

   scribe "This will be printed to the registered log, if any" 1 1
end

See also

RegisterLog