Difference between revisions of "BIS fnc functionMeta"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(Page filling)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Function|= Comments
+
{{Function|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns function's meta data.|DESCRIPTION=
+
| Returns function's meta data. |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| fncName call [[BIS_fnc_functionMeta]] |SYNTAX=
+
| functionName call [[BIS_fnc_functionMeta]] |SYNTAX=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|p1= fncName: [[String]] - Function name, e.g., '''BIS_fnc_XXXXX'''|PARAMETER1=
+
|p1= functionName: [[String]] - (Optional, default parent function's name) function name, e.g., "[[BIS_fnc_stalk]]" |PARAMETER1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Array]] of [[String|strings]]|RETURNVALUE=
+
| [[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 |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code>"BIS_fnc_functionMeta" [[call]] [[BIS_fnc_functionMeta]];</code> |=
+
|x1= <code>{{cc|returns ["A3\functions_f\Debug\fn_functionMeta.sqf", ".sqf", 0, [[false]], [[false]], [[false]], "A3", "Debug", "functionMeta"]}}
 +
"BIS_fnc_functionMeta" [[call]] [[BIS_fnc_functionMeta]];</code> |Example 1=
 +
 
 +
|x2= <code>{{cc|returns ["", "", 0, [[false]], [[false]], [[false]], "", "", ""]}}
 +
"unknownFunction" [[call]] [[BIS_fnc_functionMeta]];</code> |Example 2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[:Category:Function Group: Debug | Debug Functions]] |SEEALSO=
+
| [[:Category:Function Group: Debug | Debug Functions]], [[BIS_fnc_exportFunctionsToWiki]] |SEEALSO=
 
}}
 
}}
  
Line 35: Line 51:
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Function Group: Debug|{{uc:functionMeta}}]]
 
[[Category:Function Group: Debug|{{uc:functionMeta}}]]
[[Category:Functions|{{uc:functionMeta}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:functionMeta}}]]
 

Latest revision as of 22:06, 17 May 2020

Introduced with Arma 3 version 1.001.00
Hover & click on the images for descriptions

Description

Description:
Returns function's meta data.

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

Execution:
call
See also:
Debug FunctionsBIS_fnc_exportFunctionsToWiki

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.


Notes

Bottom Section