BIS fnc areFriendly: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Added syntax, examples and parameters.)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Function that takes two [[Side|Sides]] and compares them, returning whether they're friendly or not. |= Description
 
Description:
Compares two sides and returns if they are allied
 
Parameter(s):
_this select 0: SIDE
_this select 1: SIDE
 
Returns:
Bool - true if allies
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_areFriendly]]; --> |= Syntax
| [side,side] call '''BIS_fnc_areFriendly'''; |= Syntax


|p1= |= Parameter 1
|p1= [[Side]] - First side, will be compared to second side. |= Parameter 1
|p2= [[Side]] - Second side, will be compared to first side. |=


| |= Return value
| [[Boolean]] - True if sides are friendly to eachother, false if not. |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>areFriendly = [WEST, EAST] call BIS_fnc_areFriendly; //Compares WEST and EAST and checks if they are friendly to eachother. </code> |=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[getFriend]] |= See also


}}
}}

Revision as of 21:29, 29 September 2014


Hover & click on the images for description

Description

Description:
Function that takes two Sides and compares them, returning whether they're friendly or not.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[side,side] call BIS_fnc_areFriendly;
Parameters:
Side - First side, will be compared to second side.
Side - Second side, will be compared to first side.
Return Value:
Boolean - True if sides are friendly to eachother, false if not.

Examples

Example 1:
areFriendly = [WEST, EAST] call BIS_fnc_areFriendly; //Compares WEST and EAST and checks if they are friendly to eachother.

Additional Information

See also:
getFriend

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