BIS fnc loadFunctions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Diagnostic |GROUP1=
|gr1 = Diagnostic


| Compile scripts and save them into globally available functions. Defines [[_fnc_scriptName]] variable. |Description=
| Compile scripts and save them into globally available functions. Defines [[_fnc_scriptName]] variable.


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


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


|p2= prefix: [[String]] - variable prefix {{Informative|<tt>"BIS_fnc_"</tt> prefix is reserved and cannot be used.}} |Parameter 2=
|p2= prefix: [[String]] - variable prefix {{Informative|<tt>"BIS_fnc_"</tt> 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|Strings]] '''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|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=
* [[Array]] of [[Array]] to format [<nowiki/>[variable, fileName], [variable, fileName], …] - final variable is <tt>prefix + variable</tt>, loaded from <tt>path + fileName + ".sqf"</tt>


|p4= global: [[Boolean]] - [[true]] for global persistent execution on all clients |Parameter 4=
|p4= global: [[Boolean]] - [[true]] for global persistent execution on all clients


| [[Boolean]] - [[true]] when done |Return value=
| [[Boolean]] - [[true]] when done


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


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


| [[compile]], [[compileFinal]], [[preprocessFileLineNumbers]] |See also=
| [[compile]], [[compileFinal]], [[preprocessFileLineNumbers]]
}}
}}


Revision as of 23:10, 17 January 2021

Arma 3 logo black.png1.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:
compilecompileFinalpreprocessFileLineNumbers

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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_loadFunctions&oldid=203095"