ropeCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<tt>([^= ]+)<\/tt>" to "{{hl|$1}}")
(Add ropeType)
Line 30: Line 30:
|r1= [[Object]]
|r1= [[Object]]


|s2= [[ropeCreate]] [fromObject, fromPoint, length, segments, unroll]
|s2= [[ropeCreate]] [fromObject, fromPoint, length, segments, unroll, ropeType]


|p21= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected
|p21= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected
Line 40: Line 40:
|p24= segments: [[Number]] - (Optional) define number of rope segments
|p24= segments: [[Number]] - (Optional) define number of rope segments


|p25= unroll: [[Boolean]] - (Optional) true if rope starts at one place and falls down unrolling itself, false to create it already in full length (default: false)
|p25= unroll: [[Boolean]] - (Optional, default false) true if rope starts at one place and falls down unrolling itself, false to create it already in full length


|r2= [[Object]]
|r2= [[Object]]
Line 64: Line 64:
{{Feature | Informative |
{{Feature | Informative |
* ''fromObject'' has to be [[ropeCreate/transport | transport]] vehicle, [[alive]] with [[enableRopeAttach | rope attachment]] enabled, ''toObject'' has to be an entity, alive with [[enableRopeAttach | rope attachment]] enabled.
* ''fromObject'' has to be [[ropeCreate/transport | transport]] vehicle, [[alive]] with [[enableRopeAttach | rope attachment]] enabled, ''toObject'' has to be an entity, alive with [[enableRopeAttach | rope attachment]] enabled.
* {{hl|ropeEndType}} is defined in config under {{hl|"CfgNonAIVehicles" >> "RopeEnd"}}. Currently this is a hook that will be created on the end of the rope, and {{hl|ropeEndDownVector}} is its orientation, [0,0,-1] for example. The {{hl|"RopeEnd"}} is only shown when the rope is created object to object, it does not show on the open ended rope for some reason. There is currently no {{hl|"RopeStart"}}.}}
* {{hl|ropeEndType}} is defined in config under {{hl|"CfgNonAIVehicles" >> "RopeEnd"}}; see [[Arma 3: Ropes]]. Currently this is a hook that will be created on the end of the rope, and {{hl|ropeEndDownVector}} is its orientation, [0,0,-1] for example. The {{hl|"RopeEnd"}} is only shown when the rope is created object to object, it does not show on the open ended rope for some reason. There is currently no {{hl|"RopeStart"}}.}}


|s1= [[ropeCreate]] [fromObject, fromPoint, toObject, toPoint, length, ropeStart, ropeEnd]
|s1= [[ropeCreate]] [fromObject, fromPoint, toObject, toPoint, length, ropeStart, ropeEnd, ropeType]


|p1= fromObject: [[Object]] - [[ropeCreate/transport | transport]] where the rope originates and which fly behavior will be affected
|p1= fromObject: [[Object]] - [[ropeCreate/transport | transport]] where the rope originates and which fly behavior will be affected
Line 82: Line 82:
* ropeStartDownVector: [[String]] or [[Array]], either a memory point [[String]] or relative vector [[Array]]. If [[String]] is given, then {{hl|ropeStartDownVector}} is calculated from {{hl|fromPoint}} towards {{hl|ropeStartDownVector}} memory point
* ropeStartDownVector: [[String]] or [[Array]], either a memory point [[String]] or relative vector [[Array]]. If [[String]] is given, then {{hl|ropeStartDownVector}} is calculated from {{hl|fromPoint}} towards {{hl|ropeStartDownVector}} memory point


|p7= ropeEnd (Optional): [[Array]] - (Optional, default ["", [0,0,-1]]) array in format [ropeEndType, ropeEndDownVector] where:
|p7= ropeEnd: [[Array]] - (Optional, default ["", [0,0,-1]]) array in format [ropeEndType, ropeEndDownVector] where:
* ropeEndType: [[String]] - type of the rope end (see description)
* ropeEndType: [[String]] - type of the rope end (see description)
* ropeEndDownVector: [[String]] or [[Array]], either a memory point [[String]] or relative vector [[Array]]. If [[String]] is given, then {{hl|ropeEndDownVector}} is calculated from {{hl|toPoint}} towards {{hl|ropeEndDownVector}} memory point
* ropeEndDownVector: [[String]] or [[Array]], either a memory point [[String]] or relative vector [[Array]]. If [[String]] is given, then {{hl|ropeEndDownVector}} is calculated from {{hl|toPoint}} towards {{hl|ropeEndDownVector}} memory point
|p8= ropeType: [[String]] - (Optional, default "Rope") - rope type, {{hl|CfgVehicles}}' classname
|p8since= arma3 2.06


|r1= [[Object]] - created rope or [[objNull]] on failure
|r1= [[Object]] - created rope or [[objNull]] on failure


|s2= [[ropeCreate]] [fromObject, fromPoint, length, ropeStart, ropeEnd]
|s2= [[ropeCreate]] [fromObject, fromPoint, length, ropeStart, ropeEnd, ropeType]


|p21= fromObject: [[Object]] - [[ropeCreate/transport | transport]] where the rope originates and which fly behavior will be affected
|p21= fromObject: [[Object]] - [[ropeCreate/transport | transport]] where the rope originates and which fly behavior will be affected
Line 103: Line 106:
* ropeEndType: [[String]] - type of the rope end (see description)
* ropeEndType: [[String]] - type of the rope end (see description)
* ropeEndDownVector: [[Array]] - relative vector
* ropeEndDownVector: [[Array]] - relative vector
|p26= ropeType: [[String]] - (Optional, default "Rope") - rope type, {{hl|CfgVehicles}}' classname
|p26since= arma3 2.06


|r2= [[Object]] - created rope or [[objNull]] on failure
|r2= [[Object]] - created rope or [[objNull]] on failure
Line 114: Line 120:
|x4= A rope with a hook on the end: <code>myRope = [[ropeCreate]] [heli, "slingload0", [[player]], [0,0,2], 20, [], ["RopeEnd", [0,0,-1]]];</code>
|x4= A rope with a hook on the end: <code>myRope = [[ropeCreate]] [heli, "slingload0", [[player]], [0,0,2], 20, [], ["RopeEnd", [0,0,-1]]];</code>


|seealso= [[ropeDestroy]], [[ropeDetach]], [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[ropeUnwind]]
|seealso= [[Arma 3: Ropes]], [[ropeDestroy]], [[ropeDetach]], [[ropes]]
}}
}}


}}
}}


<dl class="command_description">
{{Note
 
|user= Tajin
<dt></dt>
|timestamp= 20141108145700
<dd class="notedate">Posted on November 8, 2014 - 14:57 (UTC)</dd>
|text= Doesn't work well for towing vehicles on the ground.<br>
<dt class="note">[[User:Tajin|Tajin]]</dt>
<dd class="note">
Doesn't work well for towing vehicles on the ground.<br>
Their wheels don't turn freely and have a LOT of friction. You'll most likely end up flipping the vehicle over if you try to tow it.<br><br>
Their wheels don't turn freely and have a LOT of friction. You'll most likely end up flipping the vehicle over if you try to tow it.<br><br>
Also note that ropes can be destroyed/cut by shooting at them.
Also note that ropes can be destroyed/cut by shooting at them.<br>
</dd>
'''Edit:''' see [[setTowParent]] since {{GVI|arma3|2.06|size=0.75}}!
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on January 4, 2015 - 03:24 (UTC)</dd>
|user= Feint
<dt class="note">[[User:Feint|Feint]]</dt>
|timestamp= 20150104032400
<dd class="note">
|text= Pay special attention to what is your '''fromObject''' and what is your '''toObject''' as this will have an impact on the physics of the rope.<br><br>
Pay special attention to what is your '''fromObject''' and what is your '''toObject''' as this will have an impact on the physics of the rope.<br><br>
''For example:'' If you want to tow an Assault CRRC from a heavier Speedboat Minigun, attach two boats together with a rope.  If you drive the Speedboat Minigun and set the CRRC as the fromObject, the rope will have almost no elasticity and the CRRC will yank around as you tow it.  However, if you set the CRRC as the toObject, the rope will have more elasticity and will be a little friendlier for the CRRC when you are towing it.
''For example:'' If you want to tow an Assault CRRC from a heavier Speedboat Minigun, attach two boats together with a rope.  If you drive the Speedboat Minigun and set the CRRC as the fromObject, the rope will have almost no elasticity and the CRRC will yank around as you tow it.  However, if you set the CRRC as the toObject, the rope will have more elasticity and will be a little friendlier for the CRRC when you are towing it.
</dd>
}}
 
</dl>

Revision as of 16:13, 25 November 2021

tkoh logo small.png Take On Helicopters
Arma 3 logo black.png Arma 3
tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
Creates a rope.
Groups:
Ropes and Sling Loading

Syntax

Syntax:
ropeCreate [fromObject, fromPoint, toObject, toPoint, segments, length]
Parameters:
fromObject: Object - object where rope starts and which fly behavior will be affected
fromPoint: Array or String - specifies where on the object the rope should start, either a string (name of memory point) or an array of three numbers (vector in model coordinates).
toObject: Object - object which is automatically attached to other side of rope (can be objNull, rope will stay with free end)
toPoint: Array or String - specifies where on the object the rope should finish, either a string (name of memory point) or an array of three numbers (vector in model coordinates)
segments: Number - define number of segments to be created
length: Number - (Optional) rope length in meters
Return Value:
Object

Alternative Syntax

Syntax:
ropeCreate [fromObject, fromPoint, length, segments, unroll, ropeType]
Parameters:
fromObject: Object - object where rope starts and which fly behavior will be affected
fromPoint: Array or String - specifies where on the object the rope should start, either a string (name of memory point) or an array of three numbers (vector in model coordinates)
length: Number - (Optional) rope length
segments: Number - (Optional) define number of rope segments
unroll: Boolean - (Optional, default false) true if rope starts at one place and falls down unrolling itself, false to create it already in full length
Return Value:
Object

Examples

Example 1:
myRope = ropeCreate [vehicle player, "fastrope0", 10, 10, true];

Additional Information

See also:
ropeDestroyropeDetachropeSetCargoMass

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
Arma 3 logo black.png1.34
GEGlobal
Hover & click on the images for description

Description

Description:
Creates a PhysX rope with given params.
ⓘ
  • fromObject has to be transport vehicle, alive with rope attachment enabled, toObject has to be an entity, alive with rope attachment enabled.
  • ropeEndType is defined in config under "CfgNonAIVehicles" >> "RopeEnd"; see Arma 3: Ropes. Currently this is a hook that will be created on the end of the rope, and ropeEndDownVector is its orientation, [0,0,-1] for example. The "RopeEnd" is only shown when the rope is created object to object, it does not show on the open ended rope for some reason. There is currently no "RopeStart".
Groups:
Ropes and Sling Loading

Syntax

Syntax:
ropeCreate [fromObject, fromPoint, toObject, toPoint, length, ropeStart, ropeEnd, ropeType]
Parameters:
fromObject: Object - transport where the rope originates and which fly behavior will be affected
fromPoint: String or Array - position for the rope start, either a memory point String or relative offset Array
toObject: Object - entity which is automatically attached to the end of the rope
toPoint: String or Array - position for the rope end, either a memory point String or relative offset Array
length: Number - (Optional, default -1) rope length in meters
ropeStart: Array - (Optional, default ["", [0,0,-1]]) array in format [ropeStartType, ropeStartDownVector] where:
  • ropeStartType: String - type of the rope start (see description)
  • ropeStartDownVector: String or Array, either a memory point String or relative vector Array. If String is given, then ropeStartDownVector is calculated from fromPoint towards ropeStartDownVector memory point
ropeEnd: Array - (Optional, default ["", [0,0,-1]]) array in format [ropeEndType, ropeEndDownVector] where:
  • ropeEndType: String - type of the rope end (see description)
  • ropeEndDownVector: String or Array, either a memory point String or relative vector Array. If String is given, then ropeEndDownVector is calculated from toPoint towards ropeEndDownVector memory point
since Arma 3 logo black.png2.06
ropeType: String - (Optional, default "Rope") - rope type, CfgVehicles' classname
Return Value:
Object - created rope or objNull on failure

Alternative Syntax

Syntax:
ropeCreate [fromObject, fromPoint, length, ropeStart, ropeEnd, ropeType]
Parameters:
fromObject: Object - transport where the rope originates and which fly behavior will be affected
fromPoint: String or Array - position for the rope start, either a memory point String or relative offset Array
length: Number - rope length in meters
ropeStart: Array - (Optional, default ["", [0,0,-1]]) array in format [ropeStartType, ropeStartDownVector] where:
  • ropeStartType: String - type of the rope start (see description)
  • ropeStartDownVector: String or Array, either a memory point String or relative vector Array. If String is given, then ropeStartDownVector is calculated from fromPoint towards ropeStartDownVector memory point
ropeEnd: Array - (Optional, default ["", [0,0,-1]]) array in format [ropeEndType, ropeEndDownVector] where:
  • ropeEndType: String - type of the rope end (see description)
  • ropeEndDownVector: Array - relative vector
since Arma 3 logo black.png2.06
ropeType: String - (Optional, default "Rope") - rope type, CfgVehicles' classname
Return Value:
Object - created rope or objNull on failure

Examples

Example 1:
myRope = ropeCreate [vehicle player, "slingload0", myCargo, [0, 0, 0], 10];
Example 2:
myRope = ropeCreate [veh1, [0,0,-2], veh2, [0,0,0], 10];
Example 3:
Free end rope (Alt Syntax): myRope = ropeCreate [vehicle player, [0,0,0], 10];
Example 4:
A rope with a hook on the end: myRope = ropeCreate [heli, "slingload0", player, [0,0,2], 20, [], ["RopeEnd", [0,0,-1]]];

Additional Information

See also:
Arma 3: RopesropeDestroyropeDetachropes

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 - 14:57 (UTC)
Doesn't work well for towing vehicles on the ground.
Their wheels don't turn freely and have a LOT of friction. You'll most likely end up flipping the vehicle over if you try to tow it.

Also note that ropes can be destroyed/cut by shooting at them.
Edit: see setTowParent since Arma 3 logo black.png2.06!
Feint - c
Posted on Jan 04, 2015 - 03:24 (UTC)
Pay special attention to what is your fromObject and what is your toObject as this will have an impact on the physics of the rope.

For example: If you want to tow an Assault CRRC from a heavier Speedboat Minigun, attach two boats together with a rope. If you drive the Speedboat Minigun and set the CRRC as the fromObject, the rope will have almost no elasticity and the CRRC will yank around as you tow it. However, if you set the CRRC as the toObject, the rope will have more elasticity and will be a little friendlier for the CRRC when you are towing it.
Retrieved from "https://community.bistudio.com/wiki?title=ropeCreate&oldid=296334"