BIS fnc exportFunctionsToWiki: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (sa)
m (Fix duplicate argument call)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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] call [[BIS_fnc_exportFunctionsToWiki]] |= Syntax
| [filter, timestamp] call [[BIS_fnc_exportFunctionsToWiki]] |Syntax=


|p1= filter: [[Array]] - (Optional) functions filter in format [tags,categories,functions]:
|p1= filter: [[Array]] - (Optional) functions filter in format [tags,categories,functions]:
* tags: [[String]] or [[Array]] of [[String]] - CfgFunctions tags (e.g., "BIS"). Use empty string for all of them.
* tags: [[String]] or [[Array]] of [[String]] - CfgFunctions tags (e.g., "BIS"). Use empty string for all of them.
* categories: [[String]] or [[Array]] of [[String]] - categories (e.g., "Debug"). Use empty string for all of them.
* categories: [[String]] or [[Array]] of [[String]] - categories (e.g., "Debug"). Use empty string for all of them.
* functions: [[String]] or [[Array]] of [[String]] - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them. |= Parameter 1
* functions: [[String]] or [[Array]] of [[String]] - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them. |Parameter 1=


|p2= timestamp: [[String]] - (Optional) in format "2013-09-12T16:00:00Z" |= Parameter 2
|p2= timestamp: [[String]] - (Optional) in format "2013-09-12T16:00:00Z" |Parameter 2=


| [[String]] - exported text |= Return value
| [[String]] - exported text |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export all functions}}</code> |= Example 1
|x1= <code>[] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export all functions}}</code> |Example 1=


|x2= <code><nowiki>[</nowiki>["","Arrays"]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export all Array functions}}</code> |= Example 2
|x2= <code><nowiki>[</nowiki>["","Arrays"]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export all Array functions}}</code> |Example 2=


|x3= <code><nowiki>[</nowiki>["","",["BIS_fnc_log","BIS_fnc_param"]]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export specific functions}}</code> |= Example 3
|x3= <code><nowiki>[</nowiki>["","",["BIS_fnc_log","BIS_fnc_param"]]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export specific functions}}</code> |Example 3=
____________________________________________________________________________________________
____________________________________________________________________________________________


|exec= spawn |= Execution
|exec= spawn |Execution=


| [[BIS_fnc_diagWiki]] |= See also
| [[BIS_fnc_diagWiki]] |See also=


}}
}}

Revision as of 23:42, 29 May 2018

Hover & click on the images for description

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:
Uncategorised

Syntax

Syntax:
[filter, timestamp] call BIS_fnc_exportFunctionsToWiki
Parameters:
filter: Array - (Optional) functions filter in format [tags,categories,functions]:
  • tags: String or Array of String - CfgFunctions tags (e.g., "BIS"). Use empty string for all of them.
  • categories: String or Array of String - categories (e.g., "Debug"). Use empty string for all of them.
  • functions: String or Array of String - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them.
timestamp: String - (Optional) 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

Notes

Bottom Section