loadFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofpr |Game name=
| ofpr


|1.90|Game version=
|1.90


|gr1= Program Flow |GROUP1=
|gr1= Program Flow




| Return content of given filename as string. If you plan to [[compile]] said string, be aware that the file shouldn't contain comments or [[compile]] will throw an error. If there are comments, use [[preprocessFile]]/[[preprocessFileLineNumbers]] instead. <br><br>
| Return content of given filename as string. If you plan to [[compile]] said string, be aware that the file shouldn't contain comments or [[compile]] will throw an error. If there are comments, use [[preprocessFile]]/[[preprocessFileLineNumbers]] instead. <br><br>
{{Warning | If the file you are loading is not prepared using UTF-8 encoding and contains some characters [[toArray | with codes]] > 127, they might convert incorrectly}} |DESCRIPTION=
{{Warning | If the file you are loading is not prepared using UTF-8 encoding and contains some characters [[toArray | with codes]] > 127, they might convert incorrectly}}


| [[loadFile]] fileName |SYNTAX=
| [[loadFile]] fileName


|p1= fileName: [[String]] |PARAMETER1=
|p1= fileName: [[String]]


| [[String]] |RETURNVALUE=
| [[String]]


|x1= <code>_contents = [[loadFile]] "wantedString.txt";</code> |EXAMPLE1=
|x1= <code>_contents = [[loadFile]] "wantedString.txt";</code>


|x2= <code>_contents = [[compile]] [[loadFile]] "myFunction.sqf"; {{codecomment|// will compile string into code}}</code> |EXAMPLE2=
|x2= <code>_contents = [[compile]] [[loadFile]] "myFunction.sqf"; {{codecomment|// will compile string into code}}</code>


| [[fileExists ]] [[preprocessFile]], [[preprocessFileLineNumbers]] |SEEALSO=
| [[fileExists ]] [[preprocessFile]], [[preprocessFileLineNumbers]]


}}
}}

Revision as of 01:04, 18 January 2021

ofpr version.gif1.90
Hover & click on the images for description

Description

Description:
Return content of given filename as string. If you plan to compile said string, be aware that the file shouldn't contain comments or compile will throw an error. If there are comments, use preprocessFile/preprocessFileLineNumbers instead.

⚠
If the file you are loading is not prepared using UTF-8 encoding and contains some characters with codes > 127, they might convert incorrectly
Groups:
Program Flow

Syntax

Syntax:
loadFile fileName
Parameters:
fileName: String
Return Value:
String

Examples

Example 1:
_contents = loadFile "wantedString.txt";
Example 2:
_contents = compile loadFile "myFunction.sqf"; // will compile string into code

Additional Information

See also:
fileExists preprocessFilepreprocessFileLineNumbers

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Posted on 25 January 2016 - 12:13
James
Notice that you will have to activate file patching via -filePatching. Otherwise, execVM and loadFile will *not* load any files outside your mission folder (like the global scripts).

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=loadFile&oldid=206015"