FileToString

From the Oblivion ConstructionSet Wiki
Revision as of 18:12, 19 July 2025 by QQuix (talk | contribs) (Found an undocumented parameter)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

A command for Pluggy.

Syntax:

FileToString FilenameStringID:long TargetStringID:long Global:short RootID:short 

Reads the contents of the specified file and stores it in the target string.

  • FileToString copies the entire file, character for character. As such the input may contain Tab characters, End of Line characters, or other data which may not display properly in Oblivion.
  • If you want to modify a string from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the string is protected the function will fail.
  • RootID specifies in which folder the file is located. Default is 0. To use 1 or 2, you must specify the Global flag as described above.
    • 0: "My Documents\My Games\Oblivion\Pluggy\User Files\"
    • 1: Oblivion Data folder.
    • 2: Oblivion main folder.