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
-____________________________________________________________________________________________
-| <pre>/*
+|descr= Compile scripts and save them into globally available functions. Defines [[_fnc_scriptName]] variable.
-	Description:
+|s1= [fileDirectory, prefix, nameVars, global] call [[BIS_fnc_loadFunctions]]
-	Compile scripts and save them into globally available functions.
-	Parameter(s):
+|p1= fileDirectory: [[String]] - script path
-: STRING - script path
-: STRING - variable prefix
-: ARRAY - list of variables to be declared. Elements can be of following types:
-			variable: STRING - variable is (prefix + variable), loaded from (path + variable + ".sqf")
-			[variable:STRING,fileName:STRING] - variable is (prefix  variable), loaded from (path + fileName + ".sqf")
-: BOOL - true for global persistent execution on all clients
-	Returns:
+|p2= prefix: [[String]] - variable prefix {{Feature|informative|{{hl|"BIS_fnc_"}} prefix is reserved and cannot be used.}}
-	BOOL
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|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"}}
-| <!-- [] call [[BIS_fnc_loadFunctions]]; --> |= Syntax
+|p4= global: [[Boolean]] - [[true]] for global persistent execution on all clients
-|p1= |= Parameter 1
+|r1= [[Boolean]] - [[true]] when done
-| |= Return value
+|x1= <sqf>["scripts\myDir\", "MY_fnc_", ["script1", "script2"], true] call BIS_fnc_loadFunctions;</sqf>
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|x2= <sqf>["scripts\myDir\", "MY_fnc_", [["script1", "script1file"], ["script2", "script2file"]], false] call BIS_fnc_loadFunctions;</sqf>
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[compile]] [[compileFinal]] [[preprocessFileLineNumbers]]
 }}
-<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:Function Group: Variables|{{uc:loadFunctions}}]]
-[[Category:Functions|{{uc:loadFunctions}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:loadFunctions}}]]