ropeUnwound: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added ropeUnwound command documentation based on ingame documentation and experimentation)
 
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(45 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


|1.33|= Game version
|gr1= Ropes and Sling Loading


____________________________________________________________________________________________
|descr= Returns [[false]] if rope length changing animation is in progress. Returns [[true]] if animation is done.


|False if unwinding in progress, otherwise true|= Description
|s1= [[ropeUnwound]] rope
____________________________________________________________________________________________


|'''ropeUnwound''' rope|= Syntax
|p1= rope: [[Object]] - given rope object
|p1 = rope: [[Object]]
| [[Boolean]] |= Return value
____________________________________________________________________________________________
|x1 = <code>_isUnwound = '''ropeUnwound''' ([[ropes]] heli1 [[select]] 0);</code> |= Example1


| [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[ropeUnwind]], [[setSlingLoad]], [[slingLoadAssistantShown]] |= See also
|r1= [[Boolean]] - [[true]] if unwinding is complete


|x1= <sqf>
waitUntil { ropeUnwound (ropes heli1 select 0) };
hint "Unwinding Complete";
</sqf>
|seealso= [[ropes]] [[canSlingLoad]] [[enableRopeAttach]] [[getSlingLoad]] [[ropeAttachedObjects]] [[ropeAttachTo]] [[ropeDestroy]] [[ropeLength]] [[ropeAttachedTo]] [[ropeCreate]] [[ropeDetach]] [[ropeAttachEnabled]] [[ropeCut]] [[ropeEndPosition]] [[ropeUnwind]] [[setSlingLoad]] [[slingLoadAssistantShown]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for description

Description

Description:
Returns false if rope length changing animation is in progress. Returns true if animation is done.
Groups:
Ropes and Sling Loading

Syntax

Syntax:
ropeUnwound rope
Parameters:
rope: Object - given rope object
Return Value:
Boolean - true if unwinding is complete

Examples

Example 1:
waitUntil { ropeUnwound (ropes heli1 select 0) }; hint "Unwinding Complete";

Additional Information

See also:
ropes canSlingLoad enableRopeAttach getSlingLoad ropeAttachedObjects ropeAttachTo ropeDestroy ropeLength ropeAttachedTo ropeCreate ropeDetach ropeAttachEnabled ropeCut ropeEndPosition ropeUnwind 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