ropeUnwind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(Add local argument/global effect courtesy of Omon XR (on Discord))
 
(46 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma 3 |Game name=
|game1= arma3
|version1= 1.34


| 1.34 |Game version=
|arg= local
____________________________________________________________________________________________
|eff= global


| Increases or decreases the rope length by the given amount. Use relative parameter for changing rope length +/- from current length. |Description=
|gr1= Ropes and Sling Loading
____________________________________________________________________________________________


| [[ropeUnwind]] [rope, speed, length, relative]|Syntax=
|descr= Increases or decreases the rope length by the given amount. Use relative parameter for changing rope length +/- from current length.
{{Feature|informative|Rope length can be in range 0.5..100 metres.}}


|p1 = rope: [[Object]] - rope object
|s1= [[ropeUnwind]] [rope, speed, length, relative]


|p2 = speed: [[Number]] - animation speed in m/s with which to lengthen or shorten the rope. Range: 0.01...20.
|p1= rope: [[Object]] - rope object


|p3 = length: [[Number]] - the amount of length change in meters. Range: 0.1...100.
|p2= speed: [[Number]] - animation speed in m/s with which to lengthen or shorten the rope, in range 0.01..20


|p4 = relative (Optional): [[Boolean]] - [[true]] will add or subtract given length from current rope length, [[false]] will resize the rope to the given length
|p3= length: [[Number]] - the amount of length change in meters, in range: 0.1..100


| [[Nothing]] |Return value=
|p4= relative: [[Boolean]] - (Optional) [[true]] will add or subtract given length from current rope length, [[false]] will resize the rope to the given length
____________________________________________________________________________________________
|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]] <nowiki>[</nowiki>[[ropes]] heli1 [[select]] 0, 3, -5, true]; {{codecomment|// decrease rope length by 5m at 3m/s}}</code> |Example 2=
|r1= [[Nothing]]


| [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[setSlingLoad]], [[slingLoadAssistantShown]] |See also=
|x1= <sqf>ropeUnwind [ropes heli1 select 0, 3, 10]; // set rope length to 10m at 3m/s</sqf>
}}


<h3 style="display:none">Notes</h3>
|x2= <sqf>ropeUnwind [ropes heli1 select 0, 3, -5, true]; // decrease rope length by 5m at 3m/s</sqf>
<dl class="command_description">


</dl>
|seealso= [[ropes]] [[canSlingLoad]] [[enableRopeAttach]] [[getSlingLoad]] [[ropeAttachedObjects]] [[ropeAttachTo]] [[ropeDestroy]] [[ropeLength]] [[ropeUnwound]] [[ropeAttachedTo]] [[ropeCreate]] [[ropeDetach]] [[ropeAttachEnabled]] [[ropeCut]] [[ropeEndPosition]] [[setSlingLoad]] [[slingLoadAssistantShown]]
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|user= Tajin
[[Category:Command Group: Ropes and Sling Loading]]
|timestamp= 20141108152800
 
|text= Unwinding speed is not linear but instead automatically accelerates at the beginning and slows down at the end.<br>
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on November 8, 2014 - 15:28 (UTC)</dd>
<dt class="note">[[User:Tajin|Tajin]]</dt>
<dd class="note">
Unwinding speed is not linear but instead automatically accelerates at the beginning and slows down at the end.<br>
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)<br>
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)<br>
High unwinding speeds (over ~250) can cause your cargo to get stuck in midair.
High unwinding speeds (over ~250) can cause your cargo to get stuck in midair.
</dd>
}}
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on January 4, 2015 - 02:43 (UTC)</dd>
<dt class="note">[[User:Feint|Feint]]</dt>
<dd class="note">
Rope length limits are between 0.5 and 100 meters.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 19:49, 14 April 2024

Arma 3 logo black.png1.34
LALocalGEGlobal
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.
ⓘ
Rope length can be in range 0.5..100 metres.
Groups:
Ropes and Sling Loading

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, 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
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:
ropes canSlingLoad enableRopeAttach getSlingLoad ropeAttachedObjects ropeAttachTo ropeDestroy ropeLength ropeUnwound ropeAttachedTo ropeCreate ropeDetach ropeAttachEnabled ropeCut ropeEndPosition setSlingLoad slingLoadAssistantShown

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
Tajin - c
Posted on Nov 08, 2014 - 15:28 (UTC)
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.
Retrieved from "https://community.bistudio.com/wiki?title=ropeUnwind&oldid=363666"