{"name":"BIS_fnc_synchronizedObjectsQueue","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","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return sequence of all synchronized objects forming either line or circle.","syntaxes":[{"syntax":"[] call BIS_fnc_synchronizedObjectsQueue","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"starting object","text":"0: OBJECT - starting object","source":"docblock"},{"name":"param1","type":"String, Array","type_expr":"String | Array<String>","optional":true,"description":"object types that are considered","text":"1: STRING or ARRAY of STRINGs (Optional) - object types that are considered","source":"docblock"},{"name":"param2","type":"Boolean","type_expr":"Boolean","optional":true,"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":"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","type_expr":"Number","optional":true,"description":"expected connection shape\n0 (default): none, can be either line or circle\n1: line expected\n2: circle expected","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","type_expr":"Array<Object> | Array","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":[{"code":["[_start,[\"ModuleToWAreaVertex_F\",\"ModuleToWAreaOptions_F\"],true,0] call BIS_fnc_synchronizedObjectsQueue;"]}],"docblock":{"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;","author":"Jiri Wainar"},"filled_from_docblock":["description","params","returns","examples"]}