BIS_fnc_synchronizedObjectsQueue

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 3 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.00

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;
*/
(Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki)

Syntax

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

Examples

Example 1:
Example needed

Additional Information

Execution:
call
Multiplayer:
-
See also:
See also needed

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To