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



Introduced in

Version:18.1.0

Description

Description:

Pauses convoy movement.

Note: This SQF function only works with convoys created using the Control AI - Military Editor Object.

The pause is executed as follows:

  1. Convoy lead vehicle stops.
  2. Other convoy vehicles continue driving until they reach the correct spacing distance from the vehicle before them.

Note: Gunner behavior remains unchanged. If the convoy reacts to lost vehicles, the reaction is completed before the convoy stops.


Syntax

Syntax:vehicle call fn_vbsCon_pauseConvoy
Parameters:
  • vehicle: Object - Lead convoy vehicle.
Return Value:Nothing

Alternative Syntax

Syntax:convoyGroup call fn_vbsCon_pauseConvoy
Parameters:
Return Value:Nothing

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 Category VBS Scripting Functions.

Examples

Examples:

(group leadVehicle1) call fn_vbsCon_pauseConvoy // Pauses convoy maneuver assigned to the group of vehicle leadVehicle1

leadVehicle1 call fn_vbsCon_pauseConvoy // The same as the previous example, but the group is selected automatically



Additional Information

See also: fn_vbsCon_resumeConvoy
Multiplayer: 
Problems: 

Notes