ropeUnwind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(updated)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Unwind rope to target length. Use relative parameter for changing rope length +/- from current length. |Description=
| Increases or decreases the rope length by the given amount. Use relative parameter for changing rope length +/- from current length. |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[ropeUnwind]] [rope, speed, targetLength, relative]|Syntax=
| [[ropeUnwind]] [rope, speed, length, relative]|Syntax=


|p1 = rope: [[Object]]
|p1 = rope: [[Object]] - rope object


|p2 = speed: [[Number]]
|p2 = speed: [[Number]] - animation speed in m/s with which to lengthen or shorten the rope


|p3 = targetLength: [[Number]]
|p3 = length: [[Number]] - the amount of length change


|p4 = relative: (optional) [[Boolean]]
|p4 = relative (Optional): [[Boolean]] - [[true]] will add or subtract given length from current rope length, [[false]] will resize the rope to the given length


| [[Nothing]] |Return value=
| [[Nothing]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1= <code>[[ropeUnwind]] [ [[ropes]] heli1 [[select]] 0, 3, 10]; {{codecomment|// set rope length to 10m at 3m/s}}</code> |Example 1=
|x1= <code>[[ropeUnwind]] <nowiki>[</nowiki>[[ropes]] heli1 [[select]] 0, 3, 10]; {{codecomment|// set rope length to 10m at 3m/s}}</code> |Example 1=


|x2= <code>[[ropeUnwind]] [ [[ropes]] heli1 [[select]] 0, 3, -5, true]; {{codecomment|// decrease rope length by 5m at 3m/s}}</code> |Example 2=
|x2= <code>[[ropeUnwind]] <nowiki>[</nowiki>[[ropes]] heli1 [[select]] 0, 3, -5, true]; {{codecomment|// decrease rope length by 5m at 3m/s}}</code> |Example 2=


| [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[setSlingLoad]], [[slingLoadAssistantShown]] |See also=
| [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[setSlingLoad]], [[slingLoadAssistantShown]] |See also=

Revision as of 19:15, 1 September 2019

Hover & click on the images for description

Description

Description:
Increases or decreases the rope length by the given amount. Use relative parameter for changing rope length +/- from current length.
Groups:
Uncategorised

Syntax

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
length: Number - the amount of length change
relative (Optional): Boolean - true will add or subtract given length from current rope length, false will resize the rope to the given length
Return Value:
Nothing

Examples

Example 1:
ropeUnwind [ropes heli1 select 0, 3, 10]; // set rope length to 10m at 3m/s
Example 2:
ropeUnwind [ropes heli1 select 0, 3, -5, true]; // decrease rope length by 5m at 3m/s

Additional Information

See also:
ropescanSlingLoadenableRopeAttachgetSlingLoadropeAttachedObjectsropeAttachToropeDestroyropeLengthropeUnwoundropeAttachedToropeCreateropeDetachropeAttachEnabledropeCutropeEndPositionsetSlingLoadslingLoadAssistantShown

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section

Posted on November 8, 2014 - 15:28 (UTC)
Tajin
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.
Posted on January 4, 2015 - 02:43 (UTC)
Feint
Rope length limits are between 0.5 and 100 meters.