isEqualTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(75 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


|1.16|= Game version
|gr1= Variables


____________________________________________________________________________________________
|descr= Performs strict comparison between var1 and var2 and returns [[true]] if equal, otherwise [[false]]. Strict means that it would check that both arguments are of the same data type and then compare the values.<br><br>
 
| Performs strict comparison between var1 and var2 and returns [[true]] if equal, otherwise [[false]]. Strict means that it would check that both arguments are of the same data type and then compare the values.<br><br>
Some differences between [[isEqualTo]] and [[==]]:
Some differences between [[isEqualTo]] and [[==]]:
* It performs case sensitive comparison on [[String]]s
* It performs case sensitive comparison on [[String]]s
* It doesn't throw error when comparing different types, i.e. ("eleven" [[isEqualTo]] 11)
* It doesn't throw error when comparing different types, i.e. ("eleven" [[isEqualTo]] 11)
* It can compare [[Array]]s, [[Script]]s and [[Boolean]]s ([[alive]] [[player]] [[isEqualTo]] [[true]])
* It can compare [[Array]]s, [[Script Handle]]s and [[Boolean]]s ([[alive]] [[player]] [[isEqualTo]] [[true]])
* It can compare non-existent game objects ([[grpNull]] [[isEqualTo]] [[grpNull]])
* It can compare non-existent game objects ([[grpNull]] [[isEqualTo]] [[grpNull]])
* It can compare [[Namespace]]s (''As of Arma 3 v1.47'')
* It is slightly faster than [[==]], especially when comparing [[String]]s
* It is slightly faster than [[==]], especially when comparing [[String]]s |= Description
* {{GVI|arma3|1.48|size= 0.75}} It can compare [[Namespace]]s
____________________________________________________________________________________________
 
| var1 '''isEqualTo''' var2 |= Syntax
 
|p1= var1: [[Anything]] |= Parameter 1
|p2= var2: [[Anything]] |= Parameter 2
 
| [[Boolean]] |= Return value
____________________________________________________________________________________________
 
|x1= <code>_arr1 = [1,[2,[3]]];
_arr2 = [1,[2,[3]]];
[[if]] (_arr1 [[isEqualTo]] _arr2) [[then]] {[[hint]] "Arrays match!"}</code> |= Example 1
 
 
|x2= <code>[[if]] (a [[isEqualTo]] b) [[then]] {[[hint]] "a is equal to b"};
[[if]] !(a [[isEqualTo]] b) [[then]] {[[hint]] "a is not equal to b"};</code> |= Example 2
 
____________________________________________________________________________________________
 
| [[isEqualTypeAll]], [[isEqualTypeAny]], [[isEqualType]], [[isEqualTypeParams]], [[isEqualTypeArray]], [[typeName]], [[Operators]], [[in]], [[find]], [[set]], [[resize]], [[switch]], [[a == b]] |= See also


{{Feature|informative|A compiled code is not equal to the same compiled code made final: <sqf>_a = compile "123"; _b = compileFinal "123"; _a isEqualTo _b; // false</sqf>}}
{{Feature|warning|When comparing [[Array]]s, if an array contains [[nil]] element, the comparison will return [[false]]. For example:<br>
<sqf>
private _array1 = [1, nil, 2];
private _array2 = [1, nil, 2];
_array1 isEqualTo _array2; // false
</sqf>
<u>UNLESS</u> the compared arrays are the same array:
<sqf>
private _array1 = [1, nil, 2];
private _array2 = _array1;
_array1 isEqualTo _array2; // true
</sqf>
See: [[isEqualRef]] and [[BIS_fnc_areEqual]] vs [[BIS_fnc_areEqualNotNil]]
}}
}}


<h3 style="display:none">Notes</h3>
|s1= val1 [[isEqualTo]] val2
<dl class="command_description">


</dl>
|p1= val1: [[Anything]]


<h3 style="display:none">Bottom Section</h3>
|p2= val2: [[Anything]]


|r1= [[Boolean]]


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|x1= <sqf>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
_arr1 = [1, [2, [3]]];
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
_arr2 = [1, [2, [3]]];
if (_arr1 isEqualTo _arr2) then { hint "Arrays match!" };
</sqf>


<!-- CONTINUE Notes -->
|x2= <sqf>
<dl class="command_description">
if (a isEqualTo b) then { hint "a is equal to b" };
<dd class="notedate">Posted on July 19, 2014 - 19:48 (UTC)</dd>
if !(a isEqualTo b) then { hint "a is not equal to b" };
<dt class="note">'''[[User:AgentRevolution|AgentRevolution]]'''</dt>
</sqf>
<dd class="note">
The behavior of "var1 [[isEqualTo]] var2" is pretty much equivalent to "var1 [[in]] [var2]", plus the ability to compare arrays, and slightly better performance.
</dd>
</dl>


<dl class="command_description">
|seealso= [[isNotEqualTo]] [[isEqualRef]] [[isEqualTypeAll]] [[isEqualTypeAny]] [[isEqualType]] [[isEqualTypeParams]] [[isEqualTypeArray]] [[a == b]] [[Operators]]
<dd class="notedate">Posted on December 3, 2014 - 13:11 (UTC)</dd>
}}
<dt class="note">[[User:Tajin|Tajin]]</dt>
<dd class="note">
Simply put, "isEqualTo" is a binary comparison. Therefor it is very fast but only accepts '''100%''' identical matches. In some other languages this is known as "&#61;&#61;&#61;" instead of "&#61;&#61;".
</dd>
</dl>
<dl class="command_description">
<dd class="notedate">Posted on May 21, 2015 - 11:26 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
A faster, case-sensitive alternative to [[BIS_fnc_areEqual]] using [[isEqualTo]]:
<code>KK_fnc_allEqual <nowiki>=</nowiki> {
[[private]] ["_arr", "_first"];
_arr <nowiki>=</nowiki> [];
_first <nowiki>=</nowiki> _this [[select]] 0;
[[for]] "_i" [[from]] 0 [[to]] [[count]] _this - 1 [[do]] {
_arr [[pushBack]] _first;
};
_arr [[isEqualTo]] _this
};


// Example
{{Note
[[1,2],[1,2],[1,3]] [[call]] KK_fnc_allEqual; //false</code>
|user= Tajin
</dd>
|datetime= 20141203131100
</dl>
|text= Simply put, "isEqualTo" is a binary comparison. Therefor it is very fast but only accepts '''100%''' identical matches. In some other languages this is known as "&#61;&#61;&#61;" instead of "&#61;&#61;".
<!-- DISCONTINUE Notes -->
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Dedmen
<dd class="notedate">Posted on May 21, 2015 - 15:30 (UTC)</dd>
|datetime= 20161103023900
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|text= When comparing with nil result is [[Nothing]].
<dd class="note">
<sqf>nil isEqualTo player;</sqf>
Array "compare" implementation using [[isEqualTo]], a faster, case-sensitive alternative to [[BIS_fnc_arrayCompare]]:
Returns [[Nothing]] instead of expected [[false]]
<code>KK_fnc_compare <nowiki>=</nowiki> {
<sqf>diag_log [nil isEqualTo player];</sqf>
_this [[select]] 0 [[isEqualTo]] (_this [[select]] 1)
Will print {{hl|[bool]}}
};
}}
 
// Example
[[1,2,3],[1,2,3]] [[call]] KK_fnc_compare; //true</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 10:01, 29 December 2022

Arma 3 logo black.png1.16
Hover & click on the images for description

Description

Description:
Performs strict comparison between var1 and var2 and returns true if equal, otherwise false. Strict means that it would check that both arguments are of the same data type and then compare the values.

Some differences between isEqualTo and ==:
ⓘ
A compiled code is not equal to the same compiled code made final:
_a = compile "123"; _b = compileFinal "123"; _a isEqualTo _b; // false
⚠
When comparing Arrays, if an array contains nil element, the comparison will return false. For example:

private _array1 = [1, nil, 2]; private _array2 = [1, nil, 2]; _array1 isEqualTo _array2; // false
UNLESS the compared arrays are the same array:
private _array1 = [1, nil, 2]; private _array2 = _array1; _array1 isEqualTo _array2; // true

See: isEqualRef and BIS_fnc_areEqual vs BIS_fnc_areEqualNotNil
Groups:
Variables

Syntax

Syntax:
val1 isEqualTo val2
Parameters:
val1: Anything
val2: Anything
Return Value:
Boolean

Examples

Example 1:
_arr1 = [1, [2, [3]]]; _arr2 = [1, [2, [3]]]; if (_arr1 isEqualTo _arr2) then { hint "Arrays match!" };
Example 2:
if (a isEqualTo b) then { hint "a is equal to b" }; if !(a isEqualTo b) then { hint "a is not equal to b" };

Additional Information

See also:
isNotEqualTo isEqualRef isEqualTypeAll isEqualTypeAny isEqualType isEqualTypeParams isEqualTypeArray a == b Operators

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
Tajin - c
Date unknown
Simply put, "isEqualTo" is a binary comparison. Therefor it is very fast but only accepts 100% identical matches. In some other languages this is known as "===" instead of "==".
Dedmen - c
Date unknown
When comparing with nil result is Nothing.
nil isEqualTo player;
Returns Nothing instead of expected false
diag_log [nil isEqualTo player];
Will print [bool]
Retrieved from "https://community.bistudio.com/wiki?title=isEqualTo&oldid=336361"