BIS fnc exportFunctionsToWiki: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Diagnostic(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Diagnostic |GROUP1= | |gr1= Diagnostic |GROUP1= | ||
| Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.<br> | | Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.<br> | ||
'''Wiki Admins''' can import them using '''[[Special:Import]]'''.<br> | '''Wiki Admins''' can import them using '''[[Special:Import]]'''.<br> | ||
If the page already exists, it will be replaced only when ''timestamp'' is newer. |Description= | If the page already exists, it will be replaced only when ''timestamp'' is newer. |Description= | ||
| [filter, timestamp] spawn [[BIS_fnc_exportFunctionsToWiki]] |Syntax= | | [filter, timestamp] spawn [[BIS_fnc_exportFunctionsToWiki]] |Syntax= | ||
| Line 24: | Line 21: | ||
| [[String]] - exported text |Return value= | | [[String]] - exported text |Return value= | ||
|x1= <code>[] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{cc|export all functions}}</code> |Example 1= | |x1= <code>[] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{cc|export all functions}}</code> |Example 1= | ||
| Line 31: | Line 27: | ||
|x3= <code>[<nowiki/>["", "", ["BIS_fnc_log", "BIS_fnc_param"]]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{cc|export specific functions}}</code> |Example 3= | |x3= <code>[<nowiki/>["", "", ["BIS_fnc_log", "BIS_fnc_param"]]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{cc|export specific functions}}</code> |Example 3= | ||
|exec= spawn |Execution= | |exec= spawn |Execution= | ||
Revision as of 23:14, 16 January 2021
Description
- Description:
- Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.
Wiki Admins can import them using Special:Import.
If the page already exists, it will be replaced only when timestamp is newer. - Execution:
- spawn
- Groups:
- Diagnostic
Syntax
- Syntax:
- [filter, timestamp] spawn BIS_fnc_exportFunctionsToWiki
- Parameters:
- filter: Array - (Optional, default []) functions filter in format [tags, categories, functions]:
- tags: String or Array of Strings - CfgFunctions tags (e.g., "A3_Oldman"). Use empty string for all of them.
- categories: String or Array of Strings - categories (e.g., "Debug"). Use empty string for all of them.
- functions: String or Array of Strings - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them.
- timestamp: String - (Optional, default "2006-04-03T17:42:00Z") in format "2013-09-12T16:00:00Z"
- Return Value:
- String - exported text
Examples
- Example 1:
[] spawn BIS_fnc_exportFunctionsToWiki; // export all functions- Example 2:
[["", "Arrays"]] spawn BIS_fnc_exportFunctionsToWiki; // export all Array functions- Example 3:
[["", "", ["BIS_fnc_log", "BIS_fnc_param"]]] spawn BIS_fnc_exportFunctionsToWiki; // export specific functions
Additional Information
- See also:
- BIS_fnc_diagWiki
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