BIS fnc synchronizedObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 7/7)
m (Some wiki formatting)
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Object Manipulation


|1.00|= Game version
|descr= Get all objects of given type directly synchronized to the given object. Works in [[:Category:Eden Editor|Eden Editor]] too.
____________________________________________________________________________________________


| <pre>/*
|s1= [object, filter, preciseMatch] call [[BIS_fnc_synchronizedObjects]]
Author: Jiri Wainar


Description:
|p1= object: [[Object]] - parent object
Get all objects of given type directly synchronized to the given object. Works in EDEN too.


Parameter(s):
|p2= filter: [[String]] or [[Array]] of strings - class name filter; 1 or more class name of objects in which we are interested
0: OBJECT - parent object
1: STRING or ARRAY - class name filter; 1 or more classnames of objects we are interested about
2: BOOL - precise match; default: true - only precise class names are considered, if false, inheritance is considered


Returns:
|p3= preciseMatch: [[Boolean]] - (Optional, default [[true]]) if [[true]] only precise class names are considered, if [[false]] inheritance is considered
ARRAY - array of synchronized objects


Example:
|r1= [[Array]] of synchronized objects
[BIS_Poliakko,"LocationArea_F"] call BIS_fnc_synchronizedObjects;
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>[BIS_Poliakko, "LocationArea_F"] call BIS_fnc_synchronizedObjects;</sqf>
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_synchronizedObjects]]; --> |= Syntax
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_allSynchronizedObjects]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:synchronizedObjects}}]]
[[Category:Functions|{{uc:synchronizedObjects}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:synchronizedObjects}}]]

Latest revision as of 11:06, 8 November 2023

Hover & click on the images for description

Description

Description:
Get all objects of given type directly synchronized to the given object. Works in Eden Editor too.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[object, filter, preciseMatch] call BIS_fnc_synchronizedObjects
Parameters:
object: Object - parent object
filter: String or Array of strings - class name filter; 1 or more class name of objects in which we are interested
preciseMatch: Boolean - (Optional, default true) if true only precise class names are considered, if false inheritance is considered
Return Value:
Array of synchronized objects

Examples

Example 1:
[BIS_Poliakko, "LocationArea_F"] call BIS_fnc_synchronizedObjects;

Additional Information

See also:
BIS_fnc_allSynchronizedObjects

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