preprocessFile
Jump to navigation
Jump to search
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.
- Groups:
- System
Syntax
- Syntax:
- preprocessFile fileName
- Parameters:
- fileName: String - path to the file and name of the file
- Return Value:
- String
Examples
- Example 1:
Additional Information
- See also:
- fileExists preprocessFileLineNumbers loadFile Function SQF Syntax call spawn execVM PreProcessor 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 Mar 04, 2008 - 22:35 (UTC)
- 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 Jul 08, 2011 - 10:59 (UTC)
- Use preprocessFileLineNumbers instead as it provides more context information on error.
- Posted on Dec 17, 2013 - 13:44 (UTC)
- 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.
- Posted on Jul 25, 2014 - 18:43 (UTC)
-
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:
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:The above is all valid. However, using *.jpg or any other files saved in an image format is not possible.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.85
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: System