BIS fnc synchronizedObjectsQueue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\| )+\}\}" to "}}")
m (Text replacement - "bis_fnc_" to "BIS_fnc_")
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
|game1= arma3
|version1= 1.00


|1.00
|gr1= Object Manipulation


|gr1 = Object Manipulation
|descr= <pre>/*
 
<!---|arg= local |Multiplayer Arguments=--->
 
<!---|eff= local |Multiplayer Effects=--->
 
| <pre>/*
Author: Jiri Wainar
Author: Jiri Wainar


Line 36: Line 31:


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>{{placeholder}}<!-- Remove this after fill-in -->
*/</pre>{{Wiki|placeholder}}<!-- Remove this after fill-in -->


|[] call [[BIS_fnc_synchronizedObjectsQueue]]
|s1= [] call [[BIS_fnc_synchronizedObjectsQueue]]


|p1= parameter: Datatype - (Optional, default defValue) description
|p1=  


|Datatype - description
|r1=


|x1= <code></code>
|x1=


|seealso=
}}
}}
[[Category:Functions|{{uc:synchronizedObjectsQueue}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:synchronizedObjectsQueue}}]]

Latest revision as of 18:24, 20 June 2021

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;
*/
🏗
Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[] call BIS_fnc_synchronizedObjectsQueue
Return Value:
Return value needed

Examples

Examples:
Example needed

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