{"name":"BIS_fnc_synchronizedObjectsQueue","operator":null,"title":"BIS fnc synchronizedObjectsQueue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_synchronizedObjectsQueue","revid":286024,"updated":"2021-06-20T17:24:26Z","groups":["Object Manipulation"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Return sequence of all synchronized objects forming either line or circle.","syntaxes":[{"syntax":"[] call BIS_fnc_synchronizedObjectsQueue","since":null,"effect":null,"exec":null,"params":[{"name":"param0","type":"Object","types":["Object"],"optional":false,"default":null,"description":"starting object","since":null,"text":"0: OBJECT - starting object","source":"docblock"},{"name":"param1","type":"String, Array","types":["String","Array"],"optional":true,"default":null,"description":"object types that are considered","since":null,"text":"1: STRING or ARRAY of STRINGs (Optional) - object types that are considered","source":"docblock"},{"name":"param2","type":"Boolean","types":["Boolean"],"optional":true,"default":null,"description":"class filter uses exact match\ntrue (default): objects need to match exectly one of the filter classes\nfalse: exact match is not required, objects can inherit from one of the listed classes","since":null,"text":"2: BOOL (Optional) - class filter uses exact match\ntrue (default): objects need to match exectly one of the filter classes\nfalse: exact match is not required, objects can inherit from one of the listed classes","source":"docblock"},{"name":"param3","type":"Number","types":["Number"],"optional":true,"default":null,"description":"expected connection shape\n0 (default): none, can be either line or circle\n1: line expected\n2: circle expected","since":null,"text":"3: NUMBER (Optional) - expected connection shape\n0 (default): none, can be either line or circle\n1: line expected\n2: circle expected","source":"docblock"}],"returns":{"type":"Array, Object","types":["Array","Object"],"description":null,"text":"ARRAY of OBJECTs or empty ARRAY if error is encountered\n\nErrors:\n     There are more then 2 objects matching class filter connected.\n     Circle is required but closing connection is not detected.","source":"docblock"}}],"examples":[{"text":"```sqf\n[_start,[\"ModuleToWAreaVertex_F\",\"ModuleToWAreaOptions_F\"],true,0] call BIS_fnc_synchronizedObjectsQueue;\n```","code":["[_start,[\"ModuleToWAreaVertex_F\",\"ModuleToWAreaOptions_F\"],true,0] call BIS_fnc_synchronizedObjectsQueue;"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":[],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Object Manipulation","Functions","Introduced with Arma 3 version 1.00"],"docblock":{"author":"Jiri Wainar","description":"Return sequence of all synchronized objects forming either line or circle.","params":[{"index":0,"name":null,"types":["Object"],"optional":false,"default":null,"description":"starting object","text":"OBJECT - starting object"},{"index":1,"name":null,"types":["String","Array"],"optional":true,"default":null,"description":"object types that are considered","text":"STRING or ARRAY of STRINGs (Optional) - object types that are considered"},{"index":2,"name":null,"types":["Boolean"],"optional":true,"default":null,"description":"class filter uses exact match\ntrue (default): objects need to match exectly one of the filter classes\nfalse: exact match is not required, objects can inherit from one of the listed classes","text":"BOOL (Optional) - class filter uses exact match\ntrue (default): objects need to match exectly one of the filter classes\nfalse: exact match is not required, objects can inherit from one of the listed classes"},{"index":3,"name":null,"types":["Number"],"optional":true,"default":null,"description":"expected connection shape\n0 (default): none, can be either line or circle\n1: line expected\n2: circle expected","text":"NUMBER (Optional) - expected connection shape\n0 (default): none, can be either line or circle\n1: line expected\n2: circle expected"}],"returns":{"types":["Array","Object"],"text":"ARRAY of OBJECTs or empty ARRAY if error is encountered\n\nErrors:\n     There are more then 2 objects matching class filter connected.\n     Circle is required but closing connection is not detected."},"examples":["[_start,[\"ModuleToWAreaVertex_F\",\"ModuleToWAreaOptions_F\"],true,0] call BIS_fnc_synchronizedObjectsQueue;"],"syntax":null,"execution":null,"notes":null,"requirements":null,"meta":{},"text":"Author: Jiri Wainar\n\nDescription:\nReturn sequence of all synchronized objects forming either line or circle.\n\nParameter(s):\n    0: OBJECT - starting object\n    1: STRING or ARRAY of STRINGs (Optional) - object types that are considered\n    2: BOOL (Optional) - class filter uses exact match\n        true (default): objects need to match exectly one of the filter classes\n        false: exact match is not required, objects can inherit from one of the listed classes\n    3: NUMBER (Optional) - expected connection shape\n        0 (default): none, can be either line or circle\n        1: line expected\n        2: circle expected\n\nReturns:\nARRAY of OBJECTs or empty ARRAY if error is encountered\n\nErrors:\n     There are more then 2 objects matching class filter connected.\n     Circle is required but closing connection is not detected.\n\nExample:\n[_start,[\"ModuleToWAreaVertex_F\",\"ModuleToWAreaOptions_F\"],true,0] call BIS_fnc_synchronizedObjectsQueue;"},"filled_from_docblock":["description","params","returns","examples"]}