Retitle the page as the function name.

Replace this image with the icon for the appropriate version - usually vbs3_x.x.x.gif 

Remove the Global and Local Argument and Effects icons as appropriate

Introduced in Update to the appropriate version


Description Write a useful description of what the function does


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 Update with the appropriate syntax, all parameters with links to the appropriate parameter type page, and descriptions, and a link to the appropriate return type page


[cv, cargoSpace, lv] call fn_vbs_loadVehicleToVehicleHold

  • 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 Add additional warnings here if required.

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.

Examples Update with appropriate function usage examples

[c1, "CargoCompartment_01", v1] call fn_vbs_loadVehicleToVehicleHold

Additional Information Update as appropriate

See also:fn_vbs_unloadVehicleFromVehicleHold, fn_vbs_SetupCargoAreaForVehicle

Notes Add usage notes as required 

After saving press L, to add appropriate category and version labels. Further advice to follow.