preprocessFile: Difference between revisions
Jump to navigation
Jump to search
m (Text replace - "{{uc:{{PAGENAME}}}}" to "{{uc:{{PAGENAME}}}} {{uc:{{PAGENAME}}}}") |
Lou Montana (talk | contribs) m (Text replacement - "|= Game version" to "|Game version=") |
||
(18 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| ofpr | | | ofpr |Game name= | ||
|1.85| | |1.85|Game version= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Reads and processes the content of the specified file. Preprocessor is C-like, supports comments using // or /* and */ and | | 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> | ||
{{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= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[String]] <nowiki>=</nowiki> '''preprocessFile''' fileName |= | | [[String]] <nowiki>=</nowiki> '''preprocessFile''' fileName |SYNTAX= | ||
|p1= fileName: [[String]] |= | |p1= fileName: [[String]] |PARAMETER1= | ||
| [[String]] |= | | [[String]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= < | |x1= <code>_content = [[preprocessFile]] "myFunction.sqf";</code> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[preprocessFileLineNumbers]], [[loadFile]], [[Function]], [[SQF syntax]], [[call]], [[spawn]], [[execVM]], [[PreProcessor Commands]] |= | | [[preprocessFileLineNumbers]], [[loadFile]], [[Function]], [[SQF syntax]], [[call]], [[spawn]], [[execVM]], [[PreProcessor Commands]] |SEEALSO= | ||
}} | }} | ||
Line 36: | Line 37: | ||
<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. | ||
<dd class="notedate">Posted on December 17, 2013 | |||
<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]''' | |||
<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]] | |||
<dd class="notedate">Posted on July 25, 2014 | |||
<dt class="note">'''[[User:BrotherhoodOfHam|BrotherhoodOfHam]]''' | |||
<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: | |||
<br/>boop.html: | |||
<code><t align = 'center' valign = 'middle' shadow = '0' size = '2'>structured text</t></code> | |||
init.sqf: | |||
<code>_text = [[parseText]] [[preprocessFile]] "boop.html"; | |||
[[hint]] _text; | |||
</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. | |||
<br/> | |||
Example 2: | |||
<br/> | |||
init.sqf: <br/> | |||
<code>[[hint]] [[preprocessFile]] "description.ext"; | |||
[[copyToClipboard]] [[preprocessFile]] "mission.sqm"; | |||
</code> | |||
The above is all valid. However, using *.jpg or any other files saved in an image format is not possible. | |||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
Line 41: | Line 67: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands|PREPROCESSFILE]] | [[Category:Scripting Commands|PREPROCESSFILE]] | ||
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands OFP 1.96|PREPROCESSFILE]] | [[Category:Scripting Commands OFP 1.96|PREPROCESSFILE]] | ||
[[Category:Scripting Commands ArmA|PREPROCESSFILE]] | [[Category:Scripting Commands ArmA|PREPROCESSFILE]] | ||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] |
Revision as of 16:11, 1 September 2019
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:
- Uncategorised
Syntax
Examples
- Example 1:
_content = preprocessFile "myFunction.sqf";
Additional Information
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 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.
Bottom Section
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint: Resistance version 1.85
- Operation Flashpoint: Resistance: New Scripting Commands
- Operation Flashpoint: Resistance: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands ArmA
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters