Difference between revisions of "in"

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
m (template:command argument fix)
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
'''in''' can refer to these scripting commands:
+
{{Command|= Comments
*[[in vehicle]] - Checks whether the soldier is mounted in the vehicle.
+
____________________________________________________________________________________________
*[[in Array]] - Checks whether x is equal to any element in the array.
 
*[[in location]] - Checks whether a position is within a location's area.
 
  
 +
| ofp |= Game name
  
 +
|1.00|= Game version
 +
____________________________________________________________________________________________
  
{{Disambig}}
+
| 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=
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
____________________________________________________________________________________________
 +
 
 +
| value '''in''' array |SYNTAX=
 +
|p1 = value: [[Anything]] - any value (Arma 2 cannot  match [[Array]])
 +
|p2 = array: [[Array]] - array of values
 +
| [[Boolean]] |RETURNVALUE=
 +
 
 +
| s2= unit '''in''' vehicle |SYNTAX=
 +
|p21 = unit: [[Object]] - person
 +
|p22 = vehicle: [[Object]] - transport
 +
 
 +
|r2= [[Boolean]] |RETURNVALUE=
 +
 
 +
| s3=position '''in''' location |SYNTAX=       (''available since Arma 3'')
 +
 
 +
|p41= position: [[Array]] - format [[Position2D]] or [[Position3D]] |PARAMETER1=
 +
|p42= location: [[Location]] |PARAMETER2=
 +
 
 +
| r3=[[Boolean]] |RETURNVALUE=
 +
____________________________________________________________________________________________
 +
|x1 = <code>1 [[in]] [0,1,2]; //true</code>|=
 +
 
 +
|x2 = <code>"lol" [[in]] ["Lol", "LOL", "loL"]; //false
 +
"loL" [[in]] ["Lol", "LOL", "loL"]; //true</code>|=
 +
 
 +
|x3= Arma 3:<code>[1,2,3] [[in]] <nowiki>[</nowiki>[1,2,3],[4,5,6]]; //true</code>|=
 +
 
 +
|x4 = <code>_isInCar = [[player]] '''in''' car;</code>|=
 +
 
 +
|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=
 +
 
 +
}}
 +
 
 +
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- 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>
 +
 
 +
<!-- 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">
 +
As of Arma 3 1.26:
 +
<code>[0,0,0] [[in]] [[0,0,0],[1,4,3],[5,3,1]]; //returns '''true'''
 +
[1,2,3] [[in]] [[1,2,3],[4,5,6]]; //returns '''true'''
 +
</code>
 +
Assuming it is now using comparison as found in [[isEqualTo]]
 +
</dd>
 +
</dl>
 +
<!-- DISCONTINUE Notes -->
 +
 
 +
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA]]
 +
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
[[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 14:41, 7 April 2019

Introduced with Operation Flashpoint version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

Description

Description:
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.

Syntax

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

Alternative Syntax

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

Alternative Syntax 2

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

Examples

Example 1:
1 in [0,1,2]; //true
Example 2:
"lol" in ["Lol", "LOL", "loL"]; //false "loL" in ["Lol", "LOL", "loL"]; //true
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

Multiplayer:
-
See also:
inPolygoninAreasetresizereversepushBackpushBackUniqueapplyselectfindtoArraytoStringforEachcountdeleteAtdeleteRangeappendsortparamparamsarrayIntersectsplitStringjoinString

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on 15:58, 18 January 2007 (CET)
T_D
For a case-insensitive test use count: {_x == "lol"} count ["Lol", "LOL", "loL"]; //returns 3. 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. [0,0,0] in [[0,0,0],[1,4,3],[5,3,1]]; //returns: false.

Bottom Section

Posted on August 23, 2014 - 10:10 (UTC)
PabstMirror
As of Arma 3 1.26: [0,0,0] in [[0,0,0],[1,4,3],[5,3,1]]; //returns true [1,2,3] in [[1,2,3],[4,5,6]]; //returns true Assuming it is now using comparison as found in isEqualTo
Posted on August 27, 2017 - 11:33 (UTC)
SilentSpike
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: private _onFoot = _unit in _unit;