in: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add forEach example)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(61 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
____________________________________________________________________________________________
|version2= 1.00


| Checks whether value is in array, unit is in vehicle, position is inside location or string is part of other string.
|game3= arma1
{{Informative | [[String]] comparison is case-sensitive (see Examples 2, 6).}}
|version3= 1.00
{{Feature arma3 | Since {{arma3}} you can test for arrays within arrays.}} |DESCRIPTION=
____________________________________________________________________________________________


| value [[in]] array |SYNTAX=
|game4= arma2
|version4= 1.00


|p1= value: [[Anything]] - any value (cannot  match [[Array]] before {{arma3}}) |PARAM1=
|game5= arma2oa
|version5= 1.50


|p2= array: [[Array]] - array of values |PARAM2=
|game6= tkoh
|version6= 1.00


| [[Boolean]] |RETURNVALUE=
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


|s2= unit [[in]] vehicle |SYNTAX2=
|gr1= Strings


|p21 = unit: [[Object]] - person |PARAM21=
|gr2= Arrays


|p22 = vehicle: [[Object]] - transport|PARAM22=
|gr3= Locations


|r2= [[Boolean]] |RETURNVALUE2=
|gr4= HashMap
____________________________________________________________________________________________


|s3= position [[in]] location &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}}'')|SYNTAX3=
|gr5= Unit Control


|p41= position: [[Array]] - format [[Position2D]] or [[Position3D]]|PARAM41=
|descr= Checks whether value is in array, unit is in vehicle, position is inside location or ANSI string is part of other ANSI string. If Unicode support is desired, see [[forceUnicode]].
{{Feature|informative|[[String]] comparison is case-sensitive (see Examples '''2''' and '''6''').}}


|p42= location: [[Location]] |PARAM42=
|s1= value [[in]] array


|r3= [[Boolean]] |RETURNVALUE3=
|p1= value: [[Anything]] - any value (cannot  match [[Array]] before {{arma3}})
____________________________________________________________________________________________


|s4= needle [[in]] haystack &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}} v1.95.146032'')|SYNTAX4=
|p2= array: [[Array]] - array of values


|p61= needle: [[String]] - string to search for |PARAM61=
|r1= [[Boolean]]


|p62= haystack: [[String]] - string to search in |PARAM62=
|s2= unit [[in]] vehicle


|r4= [[Boolean]] |RETURNVALUE4=
|p21= unit: [[Object]] - entity person
____________________________________________________________________________________________


|x1= <code>1 [[in]] [0, 1, 2]; {{cc|true}}</code> |Example 1=
|p22= vehicle: [[Object]] - entity vehicle


|x2= <code>[[private]] _myArray = ["Aaa", "AAa", "AAA"];
|r2= [[Boolean]]


"aaa" [[in]] _myArray; {{cc|false}}
|s3= position [[in]] location
"AAa" [[in]] _myArray; {{cc|true}}


{{cc|case-insensitive alternatives}}
|s3since= arma3 0.50
_myArray [[findIf]] { _x == "aaa"; } != -1; {{cc|true}}
 
|p41= position: [[Array]] - format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]
 
|p42= location: [[Location]]
 
|r3= [[Boolean]]
 
|s4= needle [[in]] haystack
 
|s4since= arma3 1.96
 
|p61= needle: [[String]] - string to search '''for'''
 
|p62= haystack: [[String]] - string to search '''in'''
 
|r4= [[Boolean]]
 
|s5= key [[in]] hashMap
 
|s5since= arma3 2.02
 
|p81= key: [[HashMapKey]]
 
|p82= hashMap : [[HashMap]]
 
|r5= [[Boolean]]
 
|x1= <sqf>1 in [0, 1, 2]; // true</sqf>
 
|x2= <sqf>
private _myArray = ["Aaa", "AAa", "AAA"];
 
"aaa" in _myArray; // false
"AAa" in _myArray; // true
 
// Case-insensitive alternatives:
_myArray findIf { _x == "aaa"; } != -1; // true


({
({
[[if]] ([[_x]] == "aaa") [[exitWith]] { [[_forEachIndex]] };
if (_x == "aaa") exitWith { _forEachIndex };
-1
-1
} [[forEach]] _myArray) != -1; {{cc|true, less performant but valid before [[findIf]]}}
} forEach _myArray) != -1; // true, less performant but valid before the introduction of the findIf command
 
{ if (_x == "aaa") exitWith { 1 } } count _myArray > 0; // true


{ [[if]] ([[_x]] == "aaa") [[exitWith]] {1} } [[count]] _myArray > 0; {{cc|true}}
{ _x == "aaa"; } count _myArray > 0; // true, worst performance, only option available in OFP
</sqf>


{ [[_x]] == "aaa"; } [[count]] _myArray > 0; {{cc|true, worst performance}}
|x3= <sqf>[1,2,3] in [[1,2,3], [4,5,6]]; // true - Arma 3 only</sqf>
{{cc|only option available in OFP}}</code> |Example2=


|x3= Arma 3:<code>[1,2,3] [[in]] <nowiki>[</nowiki>[1,2,3], [4,5,6]]; {{cc|true}}</code> |Example3=
|x4= <sqf>private _isInCar = player in Car;</sqf>


|x4= <code>_isInCar = [[player]] [[in]] car;</code> |Example4=
|x5= <sqf>private _isInside = [1000,2000,0] in MyLocation;</sqf>


|x5= <code>_isInside = [1000,2000,0] [[in]] myLocation;</code>|Example5=
|x6= <sqf>
private _isInString = "foo" in "foobar"; // true
_isInString = "Foo" in "foobar"; // false
</sqf>


|x6= <code>_isInString = "foo" [[in]] "foobar"; {{cc|true}}
|x7= <sqf>private _onFoot = _unit in _unit;</sqf>
_isInString = "Foo" [[in]] "foobar"; {{cc|false}}</code>|Example6=
Other options:
<sqf>private _onFoot = vehicle _unit == _unit;</sqf>
<sqf>private _onFoot = isNull objectParent _unit;</sqf>


|[[inPolygon]], [[inArea]], [[set]], [[resize]], [[reverse]], [[pushBack]], [[pushBackUnique]], [[apply]], [[select]], [[find]], [[toArray]], [[toString]], [[forEach]], [[count]], [[deleteAt]], [[deleteRange]], [[append]], [[sort]], [[param]], [[params]], [[arrayIntersect]], [[splitString]], [[joinString]]|SEEALSO=
|seealso= [[inPolygon]] [[inArea]] [[find]] [[findIf]] [[toArray]] [[forceUnicode]]
}}
}}


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


<dd class="notedate">Posted on August 27, 2017 - 11:33 (UTC)</dd>
<dt></dt>
<dt class="note">[[User:SilentSpike|SilentSpike]]</dt>
<dd class="notedate">Posted on 2019-10-08 - 21:08 (UTC)</dd>
<dd class="note">
<dt class="note">[[User:Lou Montana|Lou Montana]]</dt>
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:
<dd class="note">''From a description note:''<br>
<code>[[private]] _onFoot = _unit [[in]] _unit;</code>
''<unit>'' [[in]] ''<vehicle>'' literally does this: {{hl|c= [[vehicle]] <unit> {{=}}{{=}} <vehicle>}}. If ''<vehicle>'' is the same as ''<unit>'' the expression will return [[true]] for when the ''<unit>'' is on foot and [[false]] for when ''<unit>'' is in vehicle (see example '''7''' &amp; '''8''').
</dd>
</dd>


<!-- Note Section END -->
</dl>
</dl>
<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 ArmA]]
[[Category:Scripting Commands ArmA2]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Locations]]

Latest revision as of 19:42, 3 September 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Checks whether value is in array, unit is in vehicle, position is inside location or ANSI string is part of other ANSI string. If Unicode support is desired, see forceUnicode.
ⓘ
String comparison is case-sensitive (see Examples 2 and 6).
Groups:
StringsArraysLocationsHashMapUnit Control

Syntax 1

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

Syntax 2

Syntax:
unit in vehicle
Parameters:
unit: Object - entity person
vehicle: Object - entity vehicle
Return Value:
Boolean

Syntax 3

Syntax:
position in location
Parameters:
position: Array - format Position2D or Position3D
location: Location
Return Value:
Boolean

Syntax 4

Syntax:
needle in haystack
Parameters:
needle: String - string to search for
haystack: String - string to search in
Return Value:
Boolean

Syntax 5

Syntax:
key in hashMap
Parameters:
key: HashMapKey
hashMap : HashMap
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 ({ if (_x == "aaa") exitWith { _forEachIndex }; -1 } forEach _myArray) != -1; // true, less performant but valid before the introduction of the findIf command { if (_x == "aaa") exitWith { 1 } } count _myArray > 0; // true { _x == "aaa"; } count _myArray > 0; // true, worst performance, only option available in OFP
Example 3:
[1,2,3] in [[1,2,3], [4,5,6]]; // true - Arma 3 only
Example 4:
private _isInCar = player in Car;
Example 5:
private _isInside = [1000,2000,0] in MyLocation;
Example 6:
private _isInString = "foo" in "foobar"; // true _isInString = "Foo" in "foobar"; // false
Example 7:
private _onFoot = _unit in _unit;
Other options:
private _onFoot = vehicle _unit == _unit;
private _onFoot = isNull objectParent _unit;

Additional Information

See also:
inPolygon inArea find findIf toArray forceUnicode

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 2019-10-08 - 21:08 (UTC)
Lou Montana
From a description note:
<unit> in <vehicle> literally does this: vehicle <unit> == <vehicle>. If <vehicle> is the same as <unit> the expression will return true for when the <unit> is on foot and false for when <unit> is in vehicle (see example 7 & 8).
Retrieved from "https://community.bistudio.com/wiki?title=in&oldid=369280"