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



Introduced in

Version:17.2.0

Description

Description: Initiates towing between parent and child vehicles using a given towing mode.

Syntax

Syntax: [parent, child, type, mode, exceptions] call fn_tow_startTow
Parameters:
  • parent: Object - Parent vehicle / object to tow with.
  • child: Object - Vehicle to be towed.
  • type: String - (Optional) Towing mode. The supported values are: "CUSTOM", "ROPETOW" (default: "TOWBAR").
  • mode: Number - (Optional) Determines the mode for custom towing. The supported values are: 0 - timed, 1 - instant (default: 0 - timed).
  • exceptions: Boolean - (Optional) Determines whether the code should throw an exception upon an error (default: false).
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: Make vehicle1 tow vehicle2 using towbar:
[vehicle1, vehicle2] call fn_tow_startTow
Make vehicle1 tow vehicle2 using ropes of automatic length:
[vehicle1, vehicle2, "ROPETOW"] call fn_tow_startTow
Make vehicle1 tow vehicle2 using custom towing feature (typical for wreckers):
[vehicle1, vehicle2, "CUSTOM"] call fn_tow_startTow
Make vehicle1 tow vehicle2 using custom towing feature (typical for wreckers), with instant effect, print exception using hint:
try {[vehicle1, vehicle2, "CUSTOM", 1, true] call fn_tow_startTow} catch {hintC str _exception}

Additional Information

See also: fn tow towParent, fn tow towChild, fn tow canTow, fn tow canHitch, fn tow startHitch, fn tow startRopeTow, fn tow stopTow, fn tow stopHitch, fn tow stopRopeTow, fn tow getRopeTowConnections, fn tow getAvailableTowPoints, fn tow setPointLocked
Multiplayer:Can be applied to remote objects, the locality of the arguments does not matter.
Problems: 

Notes