BIS fnc areFriendly: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(48 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Sides


|1.00|= Game version
|descr= Function that takes two [[Side]]s and compares them, returning whether they are friendly or not.
____________________________________________________________________________________________


| <pre>/*
|s1= [side1, side2] call [[BIS_fnc_areFriendly]]


Description:
|p1= side1: [[Side]] - first side, will be compared to second side.
Compares two sides and returns if they are allied
|p2= side2: [[Side]] - second side, will be compared to first side.


Parameter(s):
|r1= [[Boolean]] - true if sides are friendly to each other, false if not.
_this select 0: SIDE
_this select 1: SIDE


Returns:
|x1= <sqf>private _areFriendly = [west, east] call BIS_fnc_areFriendly;</sqf>
Bool - true if allies
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_areFriendly]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[getFriend]] [[BIS_fnc_sideIsFriendly]] [[BIS_fnc_sideIsEnemy]]
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
<dt></dt>
<dd class="notedate">Posted on 2014-09-29 - 19:31 (UTC)</dd>
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
<dd class="note">
The friendly limit determined in the script is 0.6. Anything under 0.6 is considered hostile, whilst >=0.6 is considered friendly.
</dd>
 
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Sides|{{uc:areFriendly}}]]
[[Category:Functions|{{uc:areFriendly}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:areFriendly}}]]

Latest revision as of 16:50, 8 November 2023

Hover & click on the images for description

Description

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

Syntax

Syntax:
[side1, side2] call BIS_fnc_areFriendly
Parameters:
side1: Side - first side, will be compared to second side.
side2: Side - second side, will be compared to first side.
Return Value:
Boolean - true if sides are friendly to each other, false if not.

Examples

Example 1:
private _areFriendly = [west, east] call BIS_fnc_areFriendly;

Additional Information

See also:
getFriend BIS_fnc_sideIsFriendly BIS_fnc_sideIsEnemy

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
Posted on 2014-09-29 - 19:31 (UTC)
Tryteyker-
The friendly limit determined in the script is 0.6. Anything under 0.6 is considered hostile, whilst >=0.6 is considered friendly.