{"name":"ropeUnwind","operator":null,"title":"ropeUnwind","type":"command","url":"https://community.bistudio.com/wiki/ropeUnwind","revid":363666,"updated":"2024-04-14T18:49:41Z","groups":["Ropes and Sling Loading"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.34"}],"since":{"game":"arma3","name":"Arma 3","version":"1.34"},"arma3_since":"1.34","branch":null,"locality":{"argument":"local","effect":"global","server_exec":false},"exec":null,"description":"Increases or decreases the rope length by the given amount. Use relative parameter for changing rope length +/- from current length.\n\n> [!NOTE]\n> Rope length can be in range 0.5..100 metres.","syntaxes":[{"syntax":"ropeUnwind [rope, speed, length, relative]","since":null,"effect":null,"exec":null,"params":[{"name":"rope","type":"Object","optional":false,"default":null,"description":"rope object","types":["Object"],"since":null,"text":"rope: Object - rope object"},{"name":"speed","type":"Number","optional":false,"default":null,"description":"animation speed in m/s with which to lengthen or shorten the rope, in range 0.01..20","types":["Number"],"since":null,"text":"speed: Number - animation speed in m/s with which to lengthen or shorten the rope, in range 0.01..20"},{"name":"length","type":"Number","optional":false,"default":null,"description":"the amount of length change in meters, in range: 0.1..100","types":["Number"],"since":null,"text":"length: Number - the amount of length change in meters, in range: 0.1..100"},{"name":"relative","type":"Boolean","optional":true,"default":null,"description":"true will add or subtract given length from current rope length, false will resize the rope to the given length","types":["Boolean"],"since":null,"text":"relative: Boolean - (Optional) true will add or subtract given length from current rope length, false will resize the rope to the given length"}],"returns":{"type":"Nothing","types":["Nothing"],"description":null,"text":"Nothing"},"form":"unary","operator":null,"left":null,"right":{"text":"[rope, speed, length, relative]","types":["Array"]}}],"examples":[{"text":"```sqf\nropeUnwind [ropes heli1 select 0, 3, 10]; // set rope length to 10m at 3m/s\n```","code":["ropeUnwind [ropes heli1 select 0, 3, 10]; // set rope length to 10m at 3m/s"]},{"text":"```sqf\nropeUnwind [ropes heli1 select 0, 3, -5, true]; // decrease rope length by 5m at 3m/s\n```","code":["ropeUnwind [ropes heli1 select 0, 3, -5, true]; // decrease rope length by 5m at 3m/s"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["ropes","canSlingLoad","enableRopeAttach","getSlingLoad","ropeAttachedObjects","ropeAttachTo","ropeDestroy","ropeLength","ropeUnwound","ropeAttachedTo","ropeCreate","ropeDetach","ropeAttachEnabled","ropeCut","ropeEndPosition","setSlingLoad","slingLoadAssistantShown"],"notes":[{"user":"Tajin","date":"2014-11-08T15:28:00Z","text":"Unwinding speed is not linear but instead automatically accelerates at the beginning and slows down at the end.\n\nThe speed also only seems to have no effect when pulling the rope in. (unless the end of the rope is not attached to anything)\n\nHigh unwinding speeds (over ~250) can cause your cargo to get stuck in midair."}],"categories":["Arma 3: New Scripting Commands","Arma 3: Scripting Commands","Command Group: Ropes and Sling Loading","Introduced with Arma 3 version 1.34","Scripting Commands","Scripting Commands: Global Effect"]}