Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Introduced in

Version:18.3.0

Description

Description:

Allows an administrator to load a vehicle to a vehicle with a configured cargo space.

Note: Also works for vehicles with scripted cargo spaces, set up using fn_vbs_SetupCargoAreaForVehicle.

Syntax

Syntax:

[cv, cargoSpace, lv] call fn_vbs_loadVehicleToVehicleHold

Parameters:
  • cv: Object - Cargo vehicle to load onto.
  • cargoSpace: String - Configured name of the cargo space. For all currently configured cargo vehicles, the cargo space name "CargoCompartment_01" is always used.
  • lv: Object - Vehicle to load.
Return Value:Boolean - Returns true, if loaded successfully; false, otherwise.

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind — the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More here.

Examples

Examples:
[c1, "CargoCompartment_01", v1] call fn_vbs_loadVehicleToVehicleHold

Additional Information

See also:fn_vbs_unloadVehicleFromVehicleHold, fn_vbs_SetupCargoAreaForVehicle
Multiplayer:
Problems:

...