isVehicleCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (format)
m (Text replacement - " +\]" to "]")
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|1.62|= Game version
|version1= 1.62
____________________________________________________________________________________________


| Return transporting vehicle if vehicle is loaded in one.  |= Description
|gr1= Vehicle in Vehicle Transport
____________________________________________________________________________________________


| isVehicleCargo vehicle |= Syntax
|descr= Despite a misleading name, returns the vehicle that is transporting given vehicle in cargo. If the given vehicle is not in vehicle cargo, [[objNull]] is returned.


|p1= vehicle: [[Object]] |= Parameter 1
|s1= [[isVehicleCargo]] cargo


| [[Object]] - returns the transporting vehicle of a vehicle in cargo, if the vehicle is not being transported it will return [[objNull]] |= Return value
|p1= cargo: [[Object]] - vehicle in cargo
____________________________________________________________________________________________
 
|r1= [[Object]] - transporting vehicle


|x1= Blackfish with given variable name blackfish, with a vehicle inside called quad
|x1= Blackfish with given variable name blackfish, with a vehicle inside called quad
<code>_transportingVehicle = [[isVehicleCargo]] quad; //returns blackfish
<sqf>_transportingVehicle = isVehicleCargo quad; //returns blackfish</sqf>
//Vehicle called quad that is not being transported as cargo
|x2= Vehicle called quad that is not being transported as cargo
_transportingVehicle = [[getVehicleCargo]] quad; //returns [[objNull]]
<sqf>_transportingVehicle = isVehicleCargo quad; //returns objNull</sqf>
</code> |= Example 1
____________________________________________________________________________________________
 
|x2=  |= Example 2
____________________________________________________________________________________________
 
|mp= - |= Multiplayer Behaviour
 
| [[Arma_3_Vehicle_in_Vehicle_Transport| Vehicle in Vehicle Transport ]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[getVehicleCargo]] [[vehicleCargoEnabled]] |= See Also


|seealso= [[Arma 3: Vehicle in Vehicle Transport| Vehicle in Vehicle Transport]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[getVehicleCargo]] [[vehicleCargoEnabled]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:15, 8 November 2023

Arma 3 logo black.png1.62
Hover & click on the images for description

Description

Description:
Despite a misleading name, returns the vehicle that is transporting given vehicle in cargo. If the given vehicle is not in vehicle cargo, objNull is returned.
Groups:
Vehicle in Vehicle Transport

Syntax

Syntax:
isVehicleCargo cargo
Parameters:
cargo: Object - vehicle in cargo
Return Value:
Object - transporting vehicle

Examples

Example 1:
Blackfish with given variable name blackfish, with a vehicle inside called quad
_transportingVehicle = isVehicleCargo quad; //returns blackfish
Example 2:
Vehicle called quad that is not being transported as cargo
_transportingVehicle = isVehicleCargo quad; //returns objNull

Additional Information

See also:
Vehicle in Vehicle Transport canVehicleCargo setVehicleCargo enableVehicleCargo getVehicleCargo vehicleCargoEnabled

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
Retrieved from "https://community.bistudio.com/wiki?title=isVehicleCargo&oldid=349517"