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

Introduced in

Version:17.2.0

Description

Description: Returns a list of all rope towing connections for a given vehicle and any other vehicles in the vehicle chain.

Syntax

Syntax: [vehicle] call fn_tow_getRopeTowConnections
Parameters:
  • vehicle: Object - Vehicle or its trailer for which rope towing connections are returned.
Return Value: allConnections: Array - [ connection1, ..., connectionN ] - All rope connections:
  • connectionN: Array - [vehicle, connectionData] - Object reference and rope connection:
    • vehicle: Object - Connection owner object:
      • connectionData: Array - [ropeID, parentObject, parentMemPoint, childObject, childMemPoint] - Rope connection data:
        • ropeID: Number - Unique rope ID number.
        • parentObject: Object - Object that is towing.
        • parentMemPoint: String - Name of memory point that the rope begins at.
        • childObject: Object - Object that is being towed.
        • childMemPoint: String - Name of memory point that the rope ends at.

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: Get all rope connections of vehicle1:
_vehicle1Connections = [vehicle1] call fn_tow_getRopeTowConnections

Additional Information

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

Notes