Page tree
Skip to end of metadata
Go to start of metadata



Introduced in

Version:3.4

Description

Description:

Drops an item either from a plane, or from a position in the air, suspended by a parachute.

The recommended parachute types for cargo drops are:

  • vbs_CargoParachute_lclv - Low Cost Low Velocity.
  • vbs_CargoParachute_lchv - Low Cost High Velocity.
  • vbs_CargoParachute_g12 - G-12.

Syntax

Syntax:[plane, parachute, object, total, rows, delay] call fn_vbs_cargo_drop
Parameters:
  • plane: Object - Existing (and flying) plane, to drop items from.
  • parachute: String - Class name of parachute to use (has to inherit from class ParachuteBase).
  • object: String - Class name of item to drop (only static items can be dropped, vehicles are not usable upon landing).
  • total: Number - Total number of items to drop.
  • rows: Number - Number of items to drop in one go. If total exceeds the limit specified by this parameter, then multiple drops are executed, where delay specifies the time between drops (the total number of dropped items has to be divisible by the number of rows specified, any remainders are not dropped - for example, a total of 10, with 4 rows creates only two drops, for a total of 8).
  • delay: Number - Delay (in seconds) between drops.
Return Value:Boolean - Whether the drop was executed successfully.

Alternative Syntax

Syntax:[position, direction, parachute, object, total, rows, delay] call fn_vbs_cargo_drop
Parameters:
  • position: PositionASL - Position (in the air) where the items should be dropped from.
  • direction: Number - Actual drop position is about 350m from the specified one, in the direction given by this parameter (and may increase further, depending on the drop altitude and any prevailing winds).
  • parachute: String - Class name of parachute to use (has to inherit from class ParachuteBase).
  • object: String - Class name of item to drop (currently, only static items can be dropped, vehicles are not usable upon landing).
  • total: Number - Total number of items to drop.
  • rows: Number - Number of items to drop in one go. If total exceeds the limit specified by this parameter, then multiple drops are executed, where delay specifies the time between drops (the total number of dropped items has to be divisible by the number of rows specified, any remainders are not dropped - for example, a total of 10, with 4 rows creates only two drops, for a total of 8).
  • delay: Number - Delay (in seconds) between drops.
Return Value:Script - Handle to script, which can be determined using scriptDone, once the drop has completed.

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 Functions A-Z.

Examples

Examples:
Drop 6 pallets (3 per go) from [2500,2500,500]:
[[2500,2500,500], 180, "vbs_CargoParachute_lclv", "vbs2_iso_pallet_sacks01_x", 6, 3, 2] call fn_vbs_cargo_drop
Drop 3 pallets from a plane:
[plane1, "vbs_CargoParachute_lclv", "vbs2_iso_pallet_sacks01_x", 3, 3, 0] call fn_vbs_cargo_drop

Additional Information

See also: fn vbs cargo status
Multiplayer:
Problems:

Notes