Arma 3 Scripting

BIS_fnc_synchronizedObjectsQueue

  • Arma 3 v1.00

Function · Markdown · JSON · original wiki page

Description

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

Syntax

[] call BIS_fnc_synchronizedObjectsQueue

Parameters:

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.

Examples

Example 1

[_start,["ModuleToWAreaVertex_F","ModuleToWAreaOptions_F"],true,0] call BIS_fnc_synchronizedObjectsQueue;

Function header

The comment at the top of the function's file in the game; this page's description, params, returns, examples come from it.

/*
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;
*/