BIS fnc mirrorCuratorSettings: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "Strings" to "Strings")
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.16


|1.16|= Game version
|gr1= Curator
____________________________________________________________________________________________


| Mirrors settings from one curator to another.|DESCRIPTION=
|serverExec= server
____________________________________________________________________________________________


| [from,to,modes,shareType] call [[BIS_fnc_mirrorCuratorSettings]] |SYNTAX=
|descr= Mirrors settings from one curator to another.
____________________________________________________________________________________________


|p1= from: [[Object]] or [[Array]] of objects - Curators(s) from which settings are taken|PARAMETER1=
|s1= [from, to, modes, shareType] call [[BIS_fnc_mirrorCuratorSettings]]
|p2= to: [[Object]] or [[Array]] of objects - Curators(s) to which settings are applied to|PARAMETER2=
|p3= modes: [[Array]] of [[Strings]] - Copy modes, can be:
*"addons"
*"objects"
*"coefs"
**All three modes can be combined
|PARAMETER3=
|p4= shareType: [[Boolean]] - [[True]] to share settings both ways, [[false]] to make second curator slave to the first one|PARAMETER4=
____________________________________________________________________________________________


| [[Boolean]]|RETURNVALUE=
|p1= from: [[Object]] or [[Array]] of objects - curators(s) from which settings are taken
____________________________________________________________________________________________


|x1= <code>[  
|p2= to: [[Object]] or [[Array]] of objects - curators(s) to which settings are applied to
    [curator_1,curator_2],
[curator_3,curator_4],
["addons","objects","coefs"]
] [[call]] [[BIS_fnc_mirrorCuratorSettings]];</code> |=
____________________________________________________________________________________________


| [[Curator]] |SEEALSO=
|p3= modes: [[Array]] of [[String]]s - copy modes, can be:
}}
* "addons"
<h3 style="display:none">Notes</h3>
* "objects"
<dl class="command_description">
* "coefs"
<!-- Note Section BEGIN -->
All three modes can be combined.
 
|p4= shareType: [[Boolean]] - [[true]] to share settings both ways, [[false]] to make second curator slave to the first one
 
|r1= [[Boolean]]


<!-- Note Section END -->
|x1= <sqf>[
</dl>
[curator_1, curator_2],
[curator_3, curator_4],
["addons", "objects", "coefs"]
] call BIS_fnc_mirrorCuratorSettings;</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Arma 3: Curator]]
[[Category:Function Group: Curator|{{uc:mirrorCuratorSettings}}]]
}}
[[Category:Functions|{{uc:mirrorCuratorSettings}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:mirrorCuratorSettings}}]]

Latest revision as of 22:51, 16 February 2024

Hover & click on the images for description

Description

Description:
Mirrors settings from one curator to another.
Execution:
call
Groups:
Curator

Syntax

Syntax:
[from, to, modes, shareType] call BIS_fnc_mirrorCuratorSettings
Parameters:
from: Object or Array of objects - curators(s) from which settings are taken
to: Object or Array of objects - curators(s) to which settings are applied to
modes: Array of Strings - copy modes, can be:
  • "addons"
  • "objects"
  • "coefs"
All three modes can be combined.
shareType: Boolean - true to share settings both ways, false to make second curator slave to the first one
Return Value:
Boolean

Examples

Example 1:
[ [curator_1, curator_2], [curator_3, curator_4], ["addons", "objects", "coefs"] ] call BIS_fnc_mirrorCuratorSettings;

Additional Information

See also:
Arma 3: Curator

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