preprocessFile: Difference between revisions
Jump to navigation
Jump to search
m (note format) |
Lou Montana (talk | contribs) m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ") |
||
(40 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | |game1= ofp | ||
|version1= 1.85 | |||
|1. | |game2= ofpe | ||
|version2= 1.00 | |||
| | |game3= arma1 | ||
|version3= 1.00 | |||
| | |game4= arma2 | ||
|version4= 1.00 | |||
| | |game5= arma2oa | ||
|version5= 1.50 | |||
| | |game6= tkoh | ||
|version6= 1.00 | |||
| | |||
| | |game7= arma3 | ||
|version7= 0.50 | |||
|gr1= System | |||
|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.}} | |||
|s1= [[preprocessFile]] fileName | |||
|p1= fileName: [[String]] - Path to the file and name of the file | |||
|r1= [[String]] | |||
|x1= <code>_content = [[preprocessFile]] "myFunction.sqf";</code> | |||
|seealso= [[fileExists ]] [[preprocessFileLineNumbers]], [[loadFile]], [[Function]], [[SQF Syntax]], [[call]], [[spawn]], [[execVM]], [[PreProcessor Commands]] | |||
}} | }} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<dd class="notedate">Posted on March 4, 2008 | <dt><dt> | ||
<dt class="note"> | <dd class="notedate">Posted on March 4, 2008</dd> | ||
<dt class="note">[[User:Alef|Alef]]</dt> | |||
<dd class="note">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". | <dd class="note">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". | ||
<dt><dt> | |||
<dd class="notedate">Posted on July 8, 2011 | <dd class="notedate">Posted on July 8, 2011</dd> | ||
<dt class="note"> | <dt class="note">[[User:kju|kju]]</dt> | ||
<dd class="note">Use [[preprocessFileLineNumbers]] instead as it provides more context information on error. | <dd class="note">Use [[preprocessFileLineNumbers]] instead as it provides more context information on error. | ||
<dt><dt> | |||
<dd class="notedate">Posted on December 17, 2013 | <dd class="notedate">Posted on December 17, 2013</dd> | ||
<dt class="note"> | <dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt> | ||
<dd class="note">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. | <dd class="note">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. | ||
[[Image:PreprocessFile.jpg]] | [[Image:PreprocessFile.jpg]] | ||
<dt><dt> | |||
<dd class="notedate">Posted on July 25, 2014 | <dd class="notedate">Posted on July 25, 2014</dd> | ||
<dt class="note"> | <dt class="note">[[User:BrotherhoodOfHam|BrotherhoodOfHam]]</dt> | ||
<dd class="note"><br | <dd class="note"><br>Essentially what the preprocessFile command does is it refers to the contents of a file as a string:<br> | ||
Example 1: | Example 1: | ||
<br | <br>boop.html: | ||
<code><t align = 'center' valign = 'middle' shadow = '0' size = '2'>structured text</t></code> | <code><t align = 'center' valign = 'middle' shadow = '0' size = '2'>structured text</t></code> | ||
init.sqf: | init.sqf: | ||
<code>_text = [[parseText]] [[preprocessFile]] "boop.html"; | <code>_text = [[parseText]] [[preprocessFile]] "boop.html"; | ||
[[hint]] _text; | [[hint]] _text; | ||
</code><br | </code><br> | ||
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. | 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. | ||
<br | <br> | ||
Example 2: | Example 2: | ||
<br | <br> | ||
init.sqf: <br | init.sqf: <br> | ||
<code>[[hint]] [[preprocessFile]] "description.ext"; | <code>[[hint]] [[preprocessFile]] "description.ext"; | ||
[[copyToClipboard]] [[preprocessFile]] "mission.sqm"; | [[copyToClipboard]] [[preprocessFile]] "mission.sqm"; | ||
</code> | </code> | ||
The above is all valid. However, using *.jpg or any other files saved in an image format is not possible. | The above is all valid. However, using *.jpg or any other files saved in an image format is not possible. | ||
</dl> | </dl> | ||
Revision as of 18:13, 20 June 2021
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:
_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.
- 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.
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