BIS fnc tridentExecute: Difference between revisions

Latest revision as of 15:00, 8 November 2023

1.00

Hover & click on the images for description

Description

Description:: Execute a code based on Trident relationship.
Execution:: call
Groups:: Sides

Syntax

Syntax:

[side_1, side_2, codeFriendly, codeEnemy] call BIS_fnc_tridentExecute

Parameters:

side_1: Side

side_2: Side

codeFriendly: Code - code executed when sides are friendly. Arguments passed to the code are:

0: Side - Side with higher score (when the score is even, side from param 0 is used)
1: Side - Side with lower score (when the score is even, side from param 1 is used)
2: Boolean - true when the sides are allied

codeEnemy: Code - code executed when sides are enemy

Return Value:

Boolean - true when the sides are allied

Examples

Example 1:: [west, east, { params ["_higherScore", "_lowerScore", "_areAllied"] }] call BIS_fnc_tridentExecute;

Additional Information

See also:: BIS_fnc_tridentGetRelationship BIS_fnc_tridentHandleDamage BIS_fnc_tridentSetRelationship

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= Sides
-|gr1 = Sides |GROUP1=
+|descr= Execute a code based on Trident relationship.
-____________________________________________________________________________________________
-| Execute a code based on Trident relationship.|Description=
+|s1= [side_1, side_2, codeFriendly, codeEnemy] call [[BIS_fnc_tridentExecute]]
-____________________________________________________________________________________________
-| [side_1,side_2,codeFriendly,codeEnemy] call [[BIS_fnc_tridentExecute]] |Syntax=
+|p1= side_1: [[Side]]
+|p2= side_2: [[Side]]
-|p1= side_1: [[Side]] |Parameter 1=
+|p3= codeFriendly: [[Code]] - code executed when sides are friendly. Arguments passed to the code are:
+* 0: [[Side]] - Side with higher score (when the score is even, side from param 0 is used)
+* 1: [[Side]] - Side with lower score (when the score is even, side from param 1 is used)
+* 2: [[Boolean]] - [[true]] when the sides are allied
-|p2= side_2: [[Side]] |Parameter 2=
+|p4= codeEnemy: [[Code]] - code executed when sides are enemy
-|p3= codeFriendly: [[Code]] - Code executed when sides are friendly
+|r1= [[Boolean]] - [[true]] when the sides are allied
-*Arguments passed to the code are
-**0: [[Side]] - Side with higher score (when the score is even, side from param 0 is used)
-**1: [[Side]] - Side with lower score (when the score is even, side from param 1 is used)
-**2: [[Boolean]] - [[True]] when the sides are allied|Parameter 3=
-|p4= codeEnemy: [[Code]] - Code executed when sides are enemy |Parameter 4=
+|x1= <sqf>[west, east, { params ["_higherScore", "_lowerScore", "_areAllied"] }] call BIS_fnc_tridentExecute;</sqf>
+|seealso= [[BIS_fnc_tridentGetRelationship]] [[BIS_fnc_tridentHandleDamage]] [[BIS_fnc_tridentSetRelationship]]
-| [[Boolean]] - [[True]] when the sides are allied|Return value=
-____________________________________________________________________________________________
-|x1= <code>[ [[west]], [[east]], {[[params]] ["_higherScore","_lowerScore","_areAllied"]}] [[call]] [[BIS_fnc_tridentExecute]];</code>|Example 1=
-____________________________________________________________________________________________
-| [[BIS_fnc_tridentGetRelationship]], [[BIS_fnc_tridentHandleDamage]], [[BIS_fnc_tridentSetRelationship]] |See also=
 }}
-<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:Functions|{{uc:tridentExecute}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:tridentExecute}}]]