BIS fnc synchronizedObjectsQueue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(created page)
 
m (infobox to template)
Line 35: Line 35:
Example:
Example:
[_start,["ModuleToWAreaVertex_F","ModuleToWAreaOptions_F"],true,0] call bis_fnc_synchronizedObjectsQueue;
[_start,["ModuleToWAreaVertex_F","ModuleToWAreaOptions_F"],true,0] call bis_fnc_synchronizedObjectsQueue;
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_synchronizedObjectsQueue]]|Syntax=
|[] call [[BIS_fnc_synchronizedObjectsQueue]]|Syntax=

Revision as of 15:28, 2 April 2019

Hover & click on the images for description

Description

Description:
/*
	Author: Jiri Wainar

	Description:
	Return sequence of all synchronized objects forming either line or circle.

	Parameter(s):
		0: OBJECT - starting object
		1: STRING or ARRAY of STRINGs (Optional) - object types that are considered
		2: BOOL (Optional) - class filter uses exact match
			true (default): objects need to match exectly one of the filter classes
			false: exact match is not required, objects can inherit from one of the listed classes
		3: NUMBER (Optional) - expected connection shape
			0 (default): none, can be either line or circle
			1: line expected
			2: circle expected

	Returns:
	ARRAY of OBJECTs or empty ARRAY if error is encountered

	Errors:
		* There are more then 2 objects matching class filter connected.
		* Circle is required but closing connection is not detected.

	Example:
	[_start,["ModuleToWAreaVertex_F","ModuleToWAreaOptions_F"],true,0] call bis_fnc_synchronizedObjectsQueue;
*/
Template:placeholder
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[] call BIS_fnc_synchronizedObjectsQueue
Parameters:
parameter: Datatype - (Optional, default defValue) description
Return Value:
Datatype - description

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