BIS fnc loadFunctions: Difference between revisions

Latest revision as of 00:24, 2 February 2024

1.00

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= Diagnostic
-|gr1 = Diagnostic |GROUP1=
+|descr= Compile scripts and save them into globally available functions. Defines [[_fnc_scriptName]] variable.
-____________________________________________________________________________________________
-| Compile scripts and save them into globally available functions. Defines [[_fnc_scriptName]] variable. |Description=
+|s1= [fileDirectory, prefix, nameVars, global] call [[BIS_fnc_loadFunctions]]
-____________________________________________________________________________________________
-| [fileDirectory, prefix, nameVars, global] call [[BIS_fnc_loadFunctions]] |Syntax=
+|p1= fileDirectory: [[String]] - script path
-|p1= fileDirectory: [[String]] - script path |Parameter 1=
+|p2= prefix: [[String]] - variable prefix {{Feature|informative|{{hl|"BIS_fnc_"}} prefix is reserved and cannot be used.}}
-|p2= prefix: [[String]] - variable prefix {{Informative|<tt>"BIS_fnc_"</tt> prefix is reserved and cannot be used.}} |Parameter 2=
+|p3= nameVars: [[Array]] of [[String]]s '''or''' [[Array]] of [[Array]] - list of variables to be declared.
+* [[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 {{hl|prefix + variable}}, loaded from {{hl|path + fileName + ".sqf"}}
-|p3= nameVars: [[Array]] of [[String|Strings]] '''or''' [[Array]] of [[Array]] - list of variables to be declared.
+|p4= global: [[Boolean]] - [[true]] for global persistent execution on all clients
-* [[Array]] of [[String|Strings]] to format [variable, variable, …] - final variable is <tt>prefix + variable</tt>, loaded from <tt>path + variable + ".sqf"</tt>
-* [[Array]] of [[Array]] to format [<nowiki/>[variable, fileName], [variable, fileName], …] - final variable is <tt>prefix + variable</tt>, loaded from <tt>path + fileName + ".sqf"</tt> |Parameter 3=
-|p4= global: [[Boolean]] - [[true]] for global persistent execution on all clients |Parameter 4=
+|r1= [[Boolean]] - [[true]] when done
-| [[Boolean]] - [[true]] when done |Return value=
+|x1= <sqf>["scripts\myDir\", "MY_fnc_", ["script1", "script2"], true] call BIS_fnc_loadFunctions;</sqf>
-____________________________________________________________________________________________
-|x1= <code>["scripts\myDir\", "MY_fnc_", ["script1", "script2"], [[true]]] [[call]] [[BIS_fnc_loadFunctions]];</code> |Example 1=
+|x2= <sqf>["scripts\myDir\", "MY_fnc_", [["script1", "script1file"], ["script2", "script2file"]], false] call BIS_fnc_loadFunctions;</sqf>
-|x2= <code>["scripts\myDir\", "MY_fnc_", [["script1", "script1file"], ["script2", "script2file"]], [[false]]] [[call]] [[BIS_fnc_loadFunctions]];</code> |Example 2=
+|seealso= [[compile]] [[compileFinal]] [[preprocessFileLineNumbers]]
-____________________________________________________________________________________________
-| [[compile]], [[compileFinal]], [[preprocessFileLineNumbers]] |See also=
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Functions|{{uc:loadFunctions}}]]
-[[Category:Function Group: Variables|{{uc:loadFunctions}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:loadFunctions}}]]