in: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|r2= Boolean |RETURNVALUE= " to "|r2= Boolean |RETURNVALUE2=")
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Checks whether value is in array, unit in vehicle or position inside location. In case of value in array check, [[String]] values will be compared on CaSEseNsiTIve basis (see Example 2). Note: In Arma 2 you can not test for arrays within arrays using this command. |DESCRIPTION=
| Checks whether value is in array, unit in vehicle or position inside location.
{{Informative | [[String]] value [[in]] array check will be compared on a case-sensitive basis (see Example 2).}}
{{Feature arma3 | Since {{arma3}} you can test for arrays within arrays.}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| value '''in''' array |SYNTAX=
| value [[in]] array |SYNTAX=
|p1 = value: [[Anything]] - any value (Arma 2 cannot  match [[Array]])
 
|p2 = array: [[Array]] - array of values
|p1= value: [[Anything]] - any value (Arma 2 cannot  match [[Array]])
 
|p2= array: [[Array]] - array of values
 
| [[Boolean]] |RETURNVALUE=
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
|s2= unit [[in]] vehicle |SYNTAX2=


| s2= unit '''in''' vehicle |SYNTAX=
|p21 = unit: [[Object]] - person
|p21 = unit: [[Object]] - person
|p22 = vehicle: [[Object]] - transport
|p22 = vehicle: [[Object]] - transport


|r2= [[Boolean]] |RETURNVALUE2=
|r2= [[Boolean]] |RETURNVALUE2=
| s3=position '''in''' location |SYNTAX=       (''available since Arma 3'')
____________________________________________________________________________________________
 
|s3= position [[in]] location        (''Since {{arma3}}'')|SYNTAX3=


|p41= position: [[Array]] - format [[Position2D]] or [[Position3D]] |PARAMETER1=
|p31= position: [[Array]] - format [[Position2D]] or [[Position3D]]
|p42= location: [[Location]] |PARAMETER2=


| r3=[[Boolean]] |RETURNVALUE=
|p32= location: [[Location]]
 
|r3= [[Boolean]] |RETURNVALUE3=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1 = <code>1 [[in]] [0,1,2]; //true</code>|=


|x2 = <code>"lol" [[in]] ["Lol", "LOL", "loL"]; //false
|x1 = <code>1 [[in]] [0, 1, 2]; {{cc|true}}</code> |Example 1=
"loL" [[in]] ["Lol", "LOL", "loL"]; //true</code>|Example2=


|x3= Arma 3:<code>[1,2,3] [[in]] <nowiki>[</nowiki>[1,2,3],[4,5,6]]; //true</code>|=
|x2 = <code>[[private]] _myArray = ["Aaa", "AAa", "AAA"];


|x4 = <code>_isInCar = [[player]] '''in''' car;</code>|=
"aaa" [[in]] _myArray; {{cc|false}}
"AAa" [[in]] _myArray; {{cc|true}}
 
{{cc|case-insensitive alternatives}}
_myArray [[findIf]] { _x == "aaa"; } != -1; {{cc|true}}
[[_x]] [[count]] _myArray > 0; {{cc|true, less performant but valid before [[findIf]]}}</code> |Example2=
 
|x3= Arma 3:<code>[1,2,3] [[in]] <nowiki>[</nowiki>[1,2,3], [4,5,6]]; {{cc|true}}</code> |Example3=
 
|x4= <code>_isInCar = [[player]] [[in]] car;</code> |Example4=
 
|x5= <code>_isInside = [1000,2000,0] [[in]] myLocation;</code>|Example5=


|x5= <code>_isInside = [1000,2000,0] [[in]] myLocation;</code>|=
|[[inPolygon]], [[inArea]], [[set]], [[resize]], [[reverse]], [[pushBack]], [[pushBackUnique]], [[apply]], [[select]], [[find]], [[toArray]], [[toString]], [[forEach]], [[count]], [[deleteAt]], [[deleteRange]], [[append]], [[sort]], [[param]], [[params]], [[arrayIntersect]], [[splitString]], [[joinString]]|SEEALSO=
|[[inPolygon]], [[inArea]], [[set]], [[resize]], [[reverse]], [[pushBack]], [[pushBackUnique]], [[apply]], [[select]], [[find]], [[toArray]], [[toString]], [[forEach]], [[count]], [[deleteAt]], [[deleteRange]], [[append]], [[sort]], [[param]], [[params]], [[arrayIntersect]], [[splitString]], [[joinString]]|SEEALSO=
}}
}}


Line 44: Line 62:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 15:58, 18 January 2007 (CET)
<dt class="note">'''[[User:T_D|T_D]]'''<dd class="note">
For a case-''insensitive'' test use [[count]]:
<code>{_x == "lol"} [[count]] ["Lol", "LOL", "loL"]; //returns 3.</code>
Checking if an array (for example a position) is in another array doesn't produce an error, but it will always return false. e.g.
<code>[0,0,0] '''in''' [[0,0,0],[1,4,3],[5,3,1]]; //returns: false.</code>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
<dd class="notedate">Posted on August 27, 2017 - 11:33 (UTC)</dd>
 
<dt class="note">[[User:SilentSpike|SilentSpike]]</dt>
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on August 23, 2014 - 10:10 (UTC)</dd>
<dt class="note">[[User:PabstMirror|PabstMirror]]</dt>
<dd class="note">
<dd class="note">
As of Arma 3 1.26:
The [[Object]] syntax of [[in]] might not behave as you would expect (e.g. it would always return [[true]]) when both parameters are the same object . It serves as a quick method of checking if a unit is mounted:
<code>[0,0,0] [[in]] [[0,0,0],[1,4,3],[5,3,1]]; //returns '''true'''
<code>[[private]] _onFoot = _unit [[in]] _unit;</code>
[1,2,3] [[in]] [[1,2,3],[4,5,6]]; //returns '''true'''
</code>
Assuming it is now using comparison as found in [[isEqualTo]]
</dd>
</dd>
<!-- Note Section END -->
</dl>
</dl>
<!-- DISCONTINUE Notes -->


<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA]]
[[Category:Scripting Commands ArmA]]
[[Category:Scripting Commands ArmA2]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Locations]]
[[Category:Command_Group:_Locations]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on August 27, 2017 - 11:33 (UTC)</dd>
<dt class="note">[[User:SilentSpike|SilentSpike]]</dt>
<dd class="note">
The [[Object]] syntax of [[in]] might not behave as you'd expect (e.g. it would always return [[true]]) when both parameters are the same object . It serves as a quick method of checking if a unit is mounted:
<code>[[private]] _onFoot = _unit in _unit;</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 17:05, 4 September 2019

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
Checks whether value is in array, unit in vehicle or position inside location.
ⓘ
String value in array check will be compared on a case-sensitive basis (see Example 2).
Arma 3
Since Arma 3 you can test for arrays within arrays.
Groups:
Uncategorised

Syntax 1

Syntax:
value in array
Parameters:
value: Anything - any value (Arma 2 cannot match Array)
array: Array - array of values
Return Value:
Boolean

Syntax 2

Syntax:
unit in vehicle
Parameters:
unit: Object - person
vehicle: Object - transport
position: Array - format Position2D or Position3D
location: Location
Return Value:
Boolean

Syntax 3

Syntax:
position in location        (Since Arma 3)
Return Value:
Boolean

Examples

Example 1:
1 in [0, 1, 2]; // true
Example 2:
private _myArray = ["Aaa", "AAa", "AAA"]; "aaa" in _myArray; // false "AAa" in _myArray; // true // case-insensitive alternatives _myArray findIf { _x == "aaa"; } != -1; // true _x count _myArray > 0; // true, less performant but valid before findIf
Example 3:
Arma 3:[1,2,3] in [[1,2,3], [4,5,6]]; // true
Example 4:
_isInCar = player in car;
Example 5:
_isInside = [1000,2000,0] in myLocation;

Additional Information

See also:
inPolygoninAreasetresizereversepushBackpushBackUniqueapplyselectfindtoArraytoStringforEachcountdeleteAtdeleteRangeappendsortparamparamsarrayIntersectsplitStringjoinString

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

Posted on August 27, 2017 - 11:33 (UTC)
SilentSpike
The Object syntax of in might not behave as you would expect (e.g. it would always return true) when both parameters are the same object . It serves as a quick method of checking if a unit is mounted: private _onFoot = _unit in _unit;

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=in&oldid=136877"