Difference between revisions of "FileToString"
Jump to navigation
Jump to search
imported>Speedo (Graduating from beta) |
(Found an undocumented parameter) |
||
| Line 2: | Line 2: | ||
'''Syntax:''' |
'''Syntax:''' |
||
FileToString FilenameStringID:long TargetStringID:long ''Global:short'' |
FileToString FilenameStringID:long TargetStringID:long ''Global:short RootID:short'' |
||
Reads the contents of the specified file and stores it in the target string. |
Reads the contents of the specified file and stores it in the target string. |
||
| Line 8: | Line 8: | ||
*'''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. |
*'''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. |
*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. |
|||
[[Category: Functions (Pluggy)]] |
[[Category: Functions (Pluggy)]] |
||
Latest revision as of 18:12, 19 July 2025
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.