BIS_fnc_exportFunctionsToWiki

From Bohemia Interactive Community
Revision as of 16:36, 7 May 2016 by Pennyworth (talk | contribs) (First parameter is an array, using previous version of examples would lead to a script error and the default value of exporting every function to your clipboard.)
Jump to navigation Jump to search


Hover & click on the images for description

Description

Description:
/*

	Description:
	Export function descriptions to Community Wiki.
	Exported text will be copied to clipboard in XML format.
	Import it to wiki using https://community.bistudio.com/wiki?title=Special:Import
	If the page already exists, it will be replaced only when timestamp is newer.

	Parameter(s):
		0: ARRAY - functions filter in format [<tags>,<categories>,<functions>]
			tags: STRING or ARRAY of STRINGs - CfgFunctions tags (e.g., "BIS"). 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.
		1 (Optional) STRING - timestamp in format "2013-09-12T16:00:00Z"

	Returns:
	STRING - exported text

	Example:
	Export all functions:		[] spawn bis_fnc_exportFunctionsToWiki;
	Export all Array functions:	[["","Arrays"]] spawn bis_fnc_exportFunctionsToWiki;
	Export specific functions:	[["","",["BIS_fnc_log","BIS_fnc_param"]]] spawn bis_fnc_exportFunctionsToWiki;
*/

(Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki)
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
Syntax needed
Return Value:
Return value needed

Examples

Example 1:

Additional Information

See also:
See also needed

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