preprocessFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#|[A-Z]+))?\]\] " to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpr
|game1= ofp


|1.85
|version1= 1.85
 
|game2= ofpe
 
|version2= 1.00
 
|game3= arma1
 
|version3= 1.00
 
|game4= arma2
 
|version4= 1.00
 
|game5= arma2oa
 
|version5= 1.51
 
|game6= tkoh
 
|version6= 1.00
 
|game7= arma3
 
|version7= 0.50


|gr1= System
|gr1= System


| Reads and processes the content of the specified file. Preprocessor is C-like, supports comments using // or /* and */ and [[PreProcessor Commands]].<br>Due to the hard-drive access this command executes (and the lack of caching) this command should not be used in time-critical script loops. <br><br>
|descr= Reads and processes the content of the specified file. Preprocessor is C-like, supports comments using // or /* and */ and [[PreProcessor Commands]]. Due to the hard-drive access this command executes and the lack of caching this command should not be used in time-critical script loops.
{{Feature | 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}}
{{Feature|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.}}


| [[String]] <nowiki>=</nowiki> '''preprocessFile''' fileName
|s1= '''preprocessFile''' fileName


|p1= fileName: [[String]]
|p1= fileName: [[String]] - Path to the file and name of the file


| [[String]]
|r1= [[String]]
   
   
|x1= <code>_content = [[preprocessFile]] "myFunction.sqf";</code>
|x1= <code>_content = [[preprocessFile]] "myFunction.sqf";</code>
Line 59: Line 83:
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 14:50, 27 March 2021

Logo A0.png1.85ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Reads and processes the content of the specified file. Preprocessor is C-like, supports comments using // or /* and */ and PreProcessor Commands. Due to the hard-drive access this command executes and the lack of caching this command should not be used in time-critical script loops.
⚠
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:
System

Syntax

Syntax:
preprocessFile fileName
Parameters:
fileName: String - Path to the file and name of the file
Return Value:
String

Examples

Example 1:
_content = preprocessFile "myFunction.sqf";

Additional Information

See also:
fileExists preprocessFileLineNumbersloadFileFunctionSQF SyntaxcallspawnexecVMPreProcessor Commands

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
Posted on March 4, 2008
Alef
File path is always relative to mission directory. If script dir\a.sqf includes dir\b.sqf, use "dir\b.sqf" and not "b.sqf".
Posted on July 8, 2011
kju
Use preprocessFileLineNumbers instead as it provides more context information on error.
Posted on December 17, 2013
Killzone_Kid
The main difference between preprocessFile and preprocessFileLineNumbers is that the latter adds #line directive to the target file, which allows to log the __LINE__ error happened at and the __FILE__ error happened in. PreprocessFile.jpg
Posted on July 25, 2014
BrotherhoodOfHam

Essentially what the preprocessFile command does is it refers to the contents of a file as a string:
Example 1:
boop.html: <t align = 'center' valign = 'middle' shadow = '0' size = '2'>structured text</t> init.sqf: _text = parseText preprocessFile "boop.html"; hint _text;
This is especially useful for long strings, and it works on files with any file extension as long as they can be edited with a text editor.
Example 2:
init.sqf:
hint preprocessFile "description.ext"; copyToClipboard preprocessFile "mission.sqm"; The above is all valid. However, using *.jpg or any other files saved in an image format is not possible.
Retrieved from "https://community.bistudio.com/wiki?title=preprocessFile&oldid=251871"