in: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#))?\]\] " to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp


|1.00
|version1= 1.00
 
|game2= ofpe
 
|version2= 1.00
 
|game3= arma1
 
|version3= 1.00
 
|game4= arma2
 
|version4= 1.00
 
|game5= arma2oa
 
|version5= 1.51
 
|game6= tkoh
 
|version6= 1.00
 
|game7= arma3
 
|version7= 0.50


|gr1= Strings
|gr1= Strings
Line 15: Line 39:
|gr5= Unit Control
|gr5= Unit Control


| 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]].
|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''').}}
{{Feature | Informative | [[String]] comparison is case-sensitive (see Examples '''2''' and '''6''').}}
{{Feature|arma3 | Since {{arma3}} you can test for arrays within arrays.}}


| value [[in]] array
|s1= value [[in]] array


|p1= value: [[Anything]] - any value (cannot  match [[Array]] before {{arma3}})
|p1= value: [[Anything]] - Any value (cannot  match [[Array]] before {{arma3}})


|p2= array: [[Array]] - array of values
|p2= array: [[Array]] - Array of values


| [[Boolean]]
|r1= [[Boolean]]


|s2= unit [[in]] vehicle
|s2= unit [[in]] vehicle


|p21 = unit: [[Object]] - entity person
|p21 = unit: [[Object]] - Entity person


|p22 = vehicle: [[Object]] - entity vehicle
|p22 = vehicle: [[Object]] - Entity vehicle


|r2= [[Boolean]]
|r2= [[Boolean]]
Line 37: Line 60:
|s3= position [[in]] location {{Since|arma3||y}}
|s3= position [[in]] location {{Since|arma3||y}}


|p41= position: [[Array]] - format [[Position2D]] or [[Position3D]]
|p41= position: [[Array]] - Format [[Position2D]] or [[Position3D]]


|p42= location: [[Location]]
|p42= location: [[Location]]
Line 43: Line 66:
|r3= [[Boolean]]
|r3= [[Boolean]]


|s4= needle [[in]] haystack {{Since|arma3|1.95.146032|y}}
|s4= needle [[in]] haystack {{Since|arma3|1.96|y}}


|p61= needle: [[String]] - string to search for
|p61= needle: [[String]] - String to search '''for'''


|p62= haystack: [[String]] - string to search in
|p62= haystack: [[String]] - String to search '''in'''


|r4= [[Boolean]]
|r4= [[Boolean]]
Line 88: Line 111:
_isInString = "Foo" [[in]] "foobar"; {{cc|false}}</code>
_isInString = "Foo" [[in]] "foobar"; {{cc|false}}</code>


|x7= <code>[[private]] _boarded = [[player]] [[in]] _groupVehicle;</code>
|x7= <code>[[private]] _onFoot = _unit [[in]] _unit;
 
|x8= <code>[[private]] _onFoot = _unit [[in]] _unit;
{{cc|[[vehicle]] _unit {{=}}{{=}} _unit works}}
{{cc|[[vehicle]] _unit {{=}}{{=}} _unit works}}
{{cc|[[isNull]] [[objectParent]] _unit is even faster}}</code>
{{cc|[[isNull]] [[objectParent]] _unit is even faster}}</code>


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


<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on October 8, 2019 - 21:08 (UTC)</dd>
<dd class="notedate">Posted on October 8, 2019 - 21:08 (UTC)</dd>
<dt class="note">[[User:Lou Montana|Lou Montana]]</dt>
<dt class="note">[[User:Lou Montana|Lou Montana]]</dt>
Line 105: Line 124:
''<unit>'' [[in]] ''<vehicle>'' literally does this: <tt>[[vehicle]] <unit> {{=}}{{=}} <vehicle></tt>. 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''').
''<unit>'' [[in]] ''<vehicle>'' literally does this: <tt>[[vehicle]] <unit> {{=}}{{=}} <vehicle></tt>. 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>
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 14:38, 29 March 2021

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh 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 Template:Since
Parameters:
position: Array - Format Position2D or Position3D
location: Location
Return Value:
Boolean

Syntax 4

Syntax:
needle in haystack Template:Since
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 findIf { 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:
_isInCar = player in car;
Example 5:
_isInside = [1000,2000,0] in myLocation;
Example 6:
_isInString = "foo" in "foobar"; // true _isInString = "Foo" in "foobar"; // false
Example 7:
private _onFoot = _unit in _unit; // vehicle _unit == _unit works // isNull objectParent _unit is even faster

Additional Information

See also:
inPolygoninAreafindfindIftoArrayforceUnicode

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 October 8, 2019 - 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=251991"