Description
Increases or decreases the rope length by the given amount. Use relative parameter for changing rope length +/- from current length.
Note
Rope length can be in range 0.5..100 metres.
Syntax
ropeUnwind [rope, speed, length, relative]
Parameters:
rope: Object - rope object
speed: Number - animation speed in m/s with which to lengthen or shorten the rope, in range 0.01..20
length: Number - the amount of length change in meters, in range: 0.1..100
relative: Boolean - (Optional) true will add or subtract given length from current rope length, false will resize the rope to the given length
Returns: Nothing
Examples
Example 1
ropeUnwind [ropes heli1 select 0, 3, 10];
Example 2
ropeUnwind [ropes heli1 select 0, 3, -5, true];
See also
ropes · canSlingLoad · enableRopeAttach · getSlingLoad · ropeAttachedObjects · ropeAttachTo · ropeDestroy · ropeLength · ropeUnwound · ropeAttachedTo · ropeCreate · ropeDetach · ropeAttachEnabled · ropeCut · ropeEndPosition · setSlingLoad · slingLoadAssistantShown
Unwinding speed is not linear but instead automatically accelerates at the beginning and slows down at the end.
The speed also only seems to have no effect when pulling the rope in. (unless the end of the rope is not attached to anything)
High unwinding speeds (over ~250) can cause your cargo to get stuck in midair.