BIS fnc loadFunctions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |r1=[[" to " |r1= [[")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(10 intermediate revisions by the same user not shown)
Line 8: Line 8:
|descr= Compile scripts and save them into globally available functions. Defines [[_fnc_scriptName]] variable.
|descr= Compile scripts and save them into globally available functions. Defines [[_fnc_scriptName]] variable.


|s1=[fileDirectory, prefix, nameVars, global] call [[BIS_fnc_loadFunctions]]
|s1= [fileDirectory, prefix, nameVars, global] call [[BIS_fnc_loadFunctions]]


|p1= fileDirectory: [[String]] - script path
|p1= fileDirectory: [[String]] - script path


|p2= prefix: [[String]] - variable prefix {{Feature|Informative|<tt>"BIS_fnc_"</tt> prefix is reserved and cannot be used.}}
|p2= prefix: [[String]] - variable prefix {{Feature|informative|{{hl|"BIS_fnc_"}} prefix is reserved and cannot be used.}}


|p3= nameVars: [[Array]] of [[String|Strings]] '''or''' [[Array]] of [[Array]] - list of variables to be declared.
|p3= nameVars: [[Array]] of [[String]]s '''or''' [[Array]] of [[Array]] - list of variables to be declared.
* [[Array]] of [[String|Strings]] to format [variable, variable, …] - final variable is <tt>prefix + variable</tt>, loaded from <tt>path + variable + ".sqf"</tt>
* [[Array]] of [[String]]s to format [variable, variable, …] - final variable is {{hl|prefix + variable}}, loaded from {{hl|path + variable + ".sqf"}}
* [[Array]] of [[Array]] to format [<nowiki/>[variable, fileName], [variable, fileName], …] - final variable is <tt>prefix + variable</tt>, loaded from <tt>path + fileName + ".sqf"</tt>
* [[Array]] of [[Array]] to format [<nowiki/>[variable, fileName], [variable, fileName], …] - final variable is {{hl|prefix + variable}}, loaded from {{hl|path + fileName + ".sqf"}}


|p4= global: [[Boolean]] - [[true]] for global persistent execution on all clients
|p4= global: [[Boolean]] - [[true]] for global persistent execution on all clients
Line 22: Line 22:
|r1= [[Boolean]] - [[true]] when done
|r1= [[Boolean]] - [[true]] when done


|x1= <code>["scripts\myDir\", "MY_fnc_", ["script1", "script2"], [[true]]] [[call]] [[BIS_fnc_loadFunctions]];</code>
|x1= <sqf>["scripts\myDir\", "MY_fnc_", ["script1", "script2"], true] call BIS_fnc_loadFunctions;</sqf>


|x2= <code>["scripts\myDir\", "MY_fnc_", [["script1", "script1file"], ["script2", "script2file"]], [[false]]] [[call]] [[BIS_fnc_loadFunctions]];</code>
|x2= <sqf>["scripts\myDir\", "MY_fnc_", [["script1", "script1file"], ["script2", "script2file"]], false] call BIS_fnc_loadFunctions;</sqf>


|seealso= [[compile]], [[compileFinal]], [[preprocessFileLineNumbers]]
|seealso= [[compile]] [[compileFinal]] [[preprocessFileLineNumbers]]
}}
}}

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description

Description:
Compile scripts and save them into globally available functions. Defines _fnc_scriptName variable.
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[fileDirectory, prefix, nameVars, global] call BIS_fnc_loadFunctions
Parameters:
fileDirectory: String - script path
prefix: String - variable prefix
"BIS_fnc_" prefix is reserved and cannot be used.
nameVars: Array of Strings or Array of Array - list of variables to be declared.
  • Array of Strings to format [variable, variable, …] - final variable is prefix + variable, loaded from path + variable + ".sqf"
  • Array of Array to format [[variable, fileName], [variable, fileName], …] - final variable is prefix + variable, loaded from path + fileName + ".sqf"
global: Boolean - true for global persistent execution on all clients
Return Value:
Boolean - true when done

Examples

Example 1:
["scripts\myDir\", "MY_fnc_", ["script1", "script2"], true] call BIS_fnc_loadFunctions;
Example 2:
["scripts\myDir\", "MY_fnc_", [["script1", "script1file"], ["script2", "script2file"]], false] call BIS_fnc_loadFunctions;

Additional Information

See also:
compile compileFinal preprocessFileLineNumbers

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