in: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "{{since" to "{{Since") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofp |Game name= | | ofp |Game name= | ||
Line 15: | Line 14: | ||
|gr5= Unit Control |GROUP5= | |gr5= Unit Control |GROUP5= | ||
| 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]]. | | 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]]. | ||
{{Informative | [[String]] comparison is case-sensitive (see Examples '''2''' and '''6''').}} | {{Informative | [[String]] comparison is case-sensitive (see Examples '''2''' and '''6''').}} | ||
{{Feature|arma3 | Since {{arma3}} you can test for arrays within arrays.}} |DESCRIPTION= | {{Feature|arma3 | Since {{arma3}} you can test for arrays within arrays.}} |DESCRIPTION= | ||
| value [[in]] array |SYNTAX= | | value [[in]] array |SYNTAX= | ||
Line 29: | Line 26: | ||
| [[Boolean]] |RETURNVALUE= | | [[Boolean]] |RETURNVALUE= | ||
|s2= unit [[in]] vehicle |SYNTAX2= | |s2= unit [[in]] vehicle |SYNTAX2= | ||
Line 38: | Line 34: | ||
|r2= [[Boolean]] |RETURNVALUE2= | |r2= [[Boolean]] |RETURNVALUE2= | ||
|s3= position [[in]] location {{Since|arma3||y}} |SYNTAX3= | |s3= position [[in]] location {{Since|arma3||y}} |SYNTAX3= | ||
Line 47: | Line 42: | ||
|r3= [[Boolean]] |RETURNVALUE3= | |r3= [[Boolean]] |RETURNVALUE3= | ||
|s4= needle [[in]] haystack {{Since|arma3|1.95.146032|y}} |SYNTAX4= | |s4= needle [[in]] haystack {{Since|arma3|1.95.146032|y}} |SYNTAX4= | ||
Line 56: | Line 50: | ||
|r4= [[Boolean]] |RETURNVALUE4= | |r4= [[Boolean]] |RETURNVALUE4= | ||
|s5= key [[in]] hashMap |SYNTAX5= | |s5= key [[in]] hashMap |SYNTAX5= | ||
Line 65: | Line 58: | ||
|r5= [[Boolean]] |RETURNVALUE5= | |r5= [[Boolean]] |RETURNVALUE5= | ||
|x1= <code>1 [[in]] [0, 1, 2]; {{cc|true}}</code> |Example 1= | |x1= <code>1 [[in]] [0, 1, 2]; {{cc|true}}</code> |Example 1= |
Revision as of 01:35, 17 January 2021
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.
- 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 _boarded = player in _groupVehicle;
- Example 8:
private _onFoot = _unit in _unit; // vehicle _unit == _unit works // isNull objectParent _unit is even faster
Additional Information
- See also:
- inPolygoninAreasetresizereversepushBackpushBackUniqueapplyselectfindtoArraytoStringforEachcountdeleteAtdeleteRangeappendsortparamparamsarrayIntersectsplitStringjoinStringforceUnicode
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 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).
Bottom Section
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Strings
- Command Group: Arrays
- Command Group: Locations
- Command Group: HashMap
- Command Group: Unit Control
- Scripting Commands OFP 1.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands