ropeCut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added ropeCut command documentation based on ingame documentation and experimentation)
 
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(47 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= Cuts the given rope to the specified length. If some entity was attached to the end of the rope, it will be detached. The rope remains attached to its parent transport and if the length is set to 0 or even negative does not get destroyed. Use [[ropeDestroy]] to remove it completely.{{Feature|informative|The rope could only be shortened. If the cut length is greater than current rope length, nothing happens}}


|Cut rope and detach rope from vehicle|= Description
|s1= [[ropeCut]] [rope, length]
____________________________________________________________________________________________


|'''ropeCut''' [rope, distance]|= Syntax
|p1= rope: [[Object]] - rope object obtained from [[ropeCreate]]
|p1 = rope: [[Object]]
|p2 = distance: [[Number]]
| [[Nothing]] |= Return value
____________________________________________________________________________________________
|x1 = <code>'''ropeCut''' [ [[ropes]] heli1 [[select]] 0, 5];</code> |= Example1


| [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeEndPosition]], [[ropeUnwind]], [[setSlingLoad]], [[slingLoadAssistantShown]] |= See also
|p2= length: [[Number]] - length of the rope in meters after the cut


}}
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>ropeCut [ropes heli1 select 0, 5];</sqf>
<dl class="command_description">


</dl>
|seealso= [[ropes]] [[canSlingLoad]] [[enableRopeAttach]] [[getSlingLoad]] [[ropeAttachedObjects]] [[ropeAttachTo]] [[ropeDestroy]] [[ropeLength]] [[ropeUnwound]] [[ropeAttachedTo]] [[ropeCreate]] [[ropeDetach]] [[ropeAttachEnabled]] [[ropeEndPosition]] [[ropeUnwind]] [[setSlingLoad]] [[slingLoadAssistantShown]]
 
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:11, 15 March 2024

Arma 3 logo black.png1.34
Hover & click on the images for description

Description

Description:
Cuts the given rope to the specified length. If some entity was attached to the end of the rope, it will be detached. The rope remains attached to its parent transport and if the length is set to 0 or even negative does not get destroyed. Use ropeDestroy to remove it completely.
ⓘ
The rope could only be shortened. If the cut length is greater than current rope length, nothing happens
Groups:
Ropes and Sling Loading

Syntax

Syntax:
ropeCut [rope, length]
Parameters:
rope: Object - rope object obtained from ropeCreate
length: Number - length of the rope in meters after the cut
Return Value:
Nothing

Examples

Example 1:
ropeCut [ropes heli1 select 0, 5];

Additional Information

See also:
ropes canSlingLoad enableRopeAttach getSlingLoad ropeAttachedObjects ropeAttachTo ropeDestroy ropeLength ropeUnwound ropeAttachedTo ropeCreate ropeDetach ropeAttachEnabled 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
Retrieved from "https://community.bistudio.com/wiki?title=ropeCut&oldid=353360"