vehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(sqf example; note about current arma 3 output)
m (Some wiki formatting)
 
(52 intermediate revisions by 8 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


| Vehicle in which given unit is mounted. If none, unit is returned. |= Description
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| [[Object]] <nowiki>=</nowiki> '''vehicle''' unitName |= Syntax
|game4= arma2
|version4= 1.00


|p1= unitName: [[Object]] |= Parameter 1
|game5= arma2oa
|version5= 1.50


| [[Object]] |= Return value
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00
 
|x1= SQS <code>? '''vehicle''' [[player]] <nowiki>!=</nowiki> [[player]] : [[hint]] "Player is in a vehicle"</code> |= Example 1
|x2= SQF (see Notes)<code>if ( '''vehicle''' [[player]] <nowiki>!=</nowiki> player ) then { [[hint]] "Player is in a vehicle"; };</code> |= Example 2
____________________________________________________________________________________________


| |= See also
|game7= arma3
|version7= 0.50


}}
|arg= global
 
|gr1= Object Manipulation
 
|descr= Vehicle in which given unit is mounted. If none, unit is returned. Alternatively, use [[objectParent]]
{{Feature|important|While [[vehicle]] may return the vehicle the unit is in for '''[[alive]]''' units, for dead units which are groupless, this command returns the unit itself - use [[objectParent]] instead.}}
 
|s1= [[vehicle]] unitName
 
|p1= unitName: [[Object]]
 
|r1= [[Object]]


<h3 style="display:none">Notes</h3>
|x1= SQS
<dl class="command_description">
<sqs>? vehicle player != player : hint "Player is in a vehicle"</sqs>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on February 16, 2014
<dt class="note">'''[[User:Strangepete|Strangepete]]'''
<dd class="note">As of Arma 3, ( vehicle unit == unit ) is TRUE for units in the vehicle's Driver seat, IF vehicle not named manually in Editor.
Example 2 will return TRUE if vehicle pre-named in Editor; Example 2 will return FALSE if vehicle not pre-named, and player in Driver seat
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= SQF
<sqf>if (vehicle player != player) then { hint "Player is in a vehicle" };</sqf>


[[Category:Scripting Commands|VEHICLE]]
|seealso= [[objectParent]]
[[Category:Scripting Commands OFP 1.96|VEHICLE]]
}}
[[Category:Scripting Commands OFP 1.46|VEHICLE]]
[[Category:Scripting Commands ArmA|VEHICLE]]
[[Category:Scripting Commands ArmA2|VEHICLE]]
[[Category:Scripting Commands Arma 3|VEHICLE]]

Latest revision as of 18:12, 23 March 2023

Hover & click on the images for description

Description

Description:
Vehicle in which given unit is mounted. If none, unit is returned. Alternatively, use objectParent
While vehicle may return the vehicle the unit is in for alive units, for dead units which are groupless, this command returns the unit itself - use objectParent instead.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle unitName
Parameters:
unitName: Object
Return Value:
Object

Examples

Example 1:
SQS
? vehicle player != player : hint "Player is in a vehicle"
Example 2:
SQF
if (vehicle player != player) then { hint "Player is in a vehicle" };

Additional Information

See also:
objectParent

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