BIS fnc functionMeta: Difference between revisions

Latest revision as of 16:16, 1 November 2022

1.00

Hover & click on the images for description

Description

Description:: Returns function's meta data.
Execution:: call
Groups:: Diagnostic

Syntax

Syntax:

functionName call BIS_fnc_functionMeta

Parameters:

functionName: String - (Optional, default parent function's name) function name, e.g., "BIS_fnc_stalk"

Return Value:

Array to format [fileLocation, extension, headerType, preInit, postInit, recompile, game, category, name]:

fileLocation: String
extension: String - to format ".extension", e.g ".sqf", ".fsm"
headerType: Number - one of:
- 0: No Debug - header saves parent script name and current script name into variables
- 1: Save script Map - header additionaly save an array of all parent scripts into variable
- 2: Save and log script map - apart from saving into variable, script map is also logged through debugLog
preInit: Boolean
postInit: Boolean
recompile: Boolean
game: String
category: String
name: String - simple name, without TAG_fnc

Examples

Example 1:: // returns ["A3\functions_f\Debug\fn_functionMeta.sqf", ".sqf", 0, false, false, false, "A3", "Debug", "functionMeta"] "BIS_fnc_functionMeta" call BIS_fnc_functionMeta;
Example 2:: // returns ["", "", 0, false, false, false, "", "", ""] "unknownFunction" call BIS_fnc_functionMeta;

Additional Information

See also:: Diagnostic Functions BIS_fnc_exportFunctionsToWiki

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
-____________________________________________________________________________________________
-| Returns function's meta data.|DESCRIPTION=
+|descr= Returns function's meta data.
-____________________________________________________________________________________________
-| fncName call [[BIS_fnc_functionMeta]] |SYNTAX=
+|s1= functionName call [[BIS_fnc_functionMeta]]
-____________________________________________________________________________________________
-|p1= fncName: [[String]] - Function name, e.g., '''BIS_fnc_XXXXX'''|= Parameter 1
+|p1= functionName: [[String]] - (Optional, default parent function's name) function name, e.g., "[[BIS_fnc_stalk]]"
-____________________________________________________________________________________________
-| [[Array]] of [[String|strings]]|RETURNVALUE=
+|r1= [[Array]] to format [fileLocation, extension, headerType, preInit, postInit, recompile, game, category, name]:
-____________________________________________________________________________________________
+* fileLocation: [[String]]
+* extension: [[String]] - to format ".extension", e.g ".sqf", ".fsm"
+* headerType: [[Number]] - one of:
+** 0: No Debug - header saves parent script name and current script name into variables
+** 1: Save script Map - header additionaly save an array of all parent scripts into variable
+** 2: Save and log script map - apart from saving into variable, script map is also logged through debugLog
+* preInit: [[Boolean]]
+* postInit: [[Boolean]]
+* recompile: [[Boolean]]
+* game: [[String]]
+* category: [[String]]
+* name: [[String]] - simple name, without TAG_fnc
-|x1= <code>"BIS_fnc_functionMeta" [[call]] [[BIS_fnc_functionMeta]];</code> |=
+|x1= <sqf>// returns ["A3\functions_f\Debug\fn_functionMeta.sqf", ".sqf", 0, false, false, false, "A3", "Debug", "functionMeta"]
-____________________________________________________________________________________________
+"BIS_fnc_functionMeta" call BIS_fnc_functionMeta;</sqf>
-| [[:Category:Function Group: Debug | Debug Functions]] |SEEALSO=
+|x2= <sqf>// returns ["", "", 0, false, false, false, "", "", ""]
+"unknownFunction" call BIS_fnc_functionMeta;</sqf>
+|seealso= [[:Category:Function Group: Diagnostic | Diagnostic Functions]] [[BIS_fnc_exportFunctionsToWiki]]
 }}
-<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: Debug|{{uc:functionMeta}}]]
-[[Category:Functions|{{uc:functionMeta}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:functionMeta}}]]