BIS fnc tridentExecute: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (pf)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________
| arma3 |Game name=


{{Function|= Comments
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| Execute a code based on Trident relationship.|Description=
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [side_1,side_2,codeFriendly,codeEnemy] call [[BIS_fnc_tridentExecute]] |Syntax=


Description:
Execute a code based on Trident relationship.
Parameter(s):
0: SIDE
1: SIDE
2: CODE - code executed when the sides are friendly
3: CODE - code executed when the sides are enemies


Arguments passed to the code are:
|p1= side_1: [[Side]] |Parameter 1=
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: BOOL - true when the sides are allied


Returns:
|p2= side_2: [[Side]] |Parameter 2=
BOOL - true when the sides are allied
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|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|Parameter 3=


| <!-- [] call [[BIS_fnc_tridentExecute]]; --> |= Syntax
|p4= codeEnemy: [[Code]] - Code executed when sides are enemy |Parameter 4=


|p1= |= Parameter 1


| |= Return value
| [[Boolean]] - [[True]] when the sides are allied|Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[ [[west]], [[east]], {[[params]] ["_higherScore","_lowerScore","_areAllied"]}] [[call]] [[BIS_fnc_tridentExecute]];</code>|Example 1=
 
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_tridentGetRelationship]], [[BIS_fnc_tridentHandleDamage]], [[BIS_fnc_tridentSetRelationship]] |See also=
}}
 


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 15:09, 19 June 2018

Hover & click on the images for description

Description

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

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_tridentGetRelationshipBIS_fnc_tridentHandleDamageBIS_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


Notes

Bottom Section