ropes: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added command documentation based on ingame documentation and experimentation)
 
m (Some wiki formatting)
 
(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= Returns all ropes attached to a ropes owner transport vehicle.


|Returns a vehicle's rope objects in an [[Array]].|= Description
|s1= [[ropes]] ropesOwner
____________________________________________________________________________________________


|'''ropes''' vehicle|= Syntax
|p1= ropesOwner: [[Object]] - a transport from which the ropes originate
|p1 = vehicle: [[Object]]
| [[Array]] of rope objects|= Return value
____________________________________________________________________________________________
|x1 = <code>hint str ('''ropes''' vehicle player);</code> |= Example1


|x2 = <code>_rope1 = ('''ropes''' heli1) select 0;</code> |= Example1
|r1= [[Array]] of [[Object]]s - array of the actual rope objects


|x1= <sqf>hint str (ropes vehicle player);</sqf>


| [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[ropeUnwind]] |= See also
|x2= <sqf>_rope1 = (ropes heli1) select 0;</sqf>


|seealso= [[canSlingLoad]] [[enableRopeAttach]] [[getSlingLoad]] [[ropeAttachedObjects]] [[ropeAttachTo]] [[ropeDestroy]] [[ropeLength]] [[ropeUnwound]] [[ropeAttachedTo]] [[ropeCreate]] [[ropeDetach]] [[ropeAttachEnabled]] [[ropeCut]] [[ropeEndPosition]] [[ropeUnwind]] [[setSlingLoad]] [[slingLoadAssistantShown]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Waffle SS.
 
|timestamp= 20141013020500
<dd class="notedate">Posted on 05 April, 2014
|text= The [[ropes]] command seems to return each individual sling load rope.
<dt class="note">'''[[User:Waffle SS.|Waffle SS.]]'''<dd class="note"><br>
[[ropes]] will return an empty [[Array]] if the sling load ropes are not deployed.
The '''ropes''' command seems to return each individual sling load rope. '''ropes''' will return an empty [[Array]] if the sling load ropes are not deployed. Ropes as of A3 1.33 have a cfgVehicles classname of "Rope".<br>
Ropes as of A3 1.33 have a cfgVehicles classname of "Rope".
 
}}
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 22:30, 13 May 2023

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

Description

Description:
Returns all ropes attached to a ropes owner transport vehicle.
Groups:
Ropes and Sling Loading

Syntax

Syntax:
ropes ropesOwner
Parameters:
ropesOwner: Object - a transport from which the ropes originate
Return Value:
Array of Objects - array of the actual rope objects

Examples

Example 1:
hint str (ropes vehicle player);
Example 2:
_rope1 = (ropes heli1) select 0;

Additional Information

See also:
canSlingLoad enableRopeAttach getSlingLoad ropeAttachedObjects ropeAttachTo ropeDestroy ropeLength ropeUnwound 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
Waffle SS. - c
Posted on Oct 13, 2014 - 02:05 (UTC)
The ropes command seems to return each individual sling load rope. ropes will return an empty Array if the sling load ropes are not deployed. Ropes as of A3 1.33 have a cfgVehicles classname of "Rope".
Retrieved from "https://community.bistudio.com/wiki?title=ropes&oldid=340878"