isVehicleCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(messed up name description, example fix)
Line 6: Line 6:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Return transporting vehicle if vehicle is loaded in one.  |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.  |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''isVehicleCargo''' vehicle |SYNTAX=
| '''isVehicleCargo''' cargo |SYNTAX=


|p1= vehicle: [[Object]]  |PARAMETER1=
|p1= cargo: [[Object]] - vehicle in cargo |PARAMETER1=


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


|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
<code>_transportingVehicle = [[isVehicleCargo]] quad; //returns blackfish</code> |EXAMPLE1=
//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]]
<code>_transportingVehicle = [[isVehicleCargo]] quad; //returns [[objNull]]
</code> |EXAMPLE1=
</code> |EXAMPLE2=
____________________________________________________________________________________________
 
|x2=  |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 09:19, 2 May 2019

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.
Multiplayer:
-
Groups:
Uncategorised

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

Bottom Section