ropeCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
[[Category:Scripting Commands|ROPECREATE]]
[[Category:Scripting Commands|ROPECREATE]]


{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| TKOH |= Game name
| TKOH |Game name=
|1.00|= Game version
|1.00|Game version=


| game2= arma3 |=
| game2= arma3 |Game name 2=
| version2= 1.34 |=  
| version2= 1.34 |Game version 2=


____________________________________________________________________________________________
____________________________________________________________________________________________


| Create a rope (PhysX rope in Arma 3). |= Description
| Create a rope (PhysX rope in Arma 3). |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, length]|= Syntax
| [[ropeCreate]] [fromObject, fromPoint, toObject, toPoint, segments, length] |Syntax=


|p1=[fromObject, fromPoint, toObject, toPoint, segments, length]: [[Array]]|=
|p1=[fromObject, fromPoint, toObject, toPoint, segments, length]: [[Array]]|Parameter 1=
|p2= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected |=  
|p2= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected |Parameter 2=
|p3= 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). |=  
|p3= 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). |Parameter 3=
|p4= toObject: [[Object]] - object which is automatically attached to other side of rope (can be objNull, rope will stay with free end) |=  
|p4= toObject: [[Object]] - object which is automatically attached to other side of rope (can be objNull, rope will stay with free end) |Parameter 4=
|p5= 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) |=  
|p5= 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) |Parameter 5=
|p6= segments: [[Number]] - define number of segments to be created (not used in A3) |=  
|p6= segments: [[Number]] - define number of segments to be created (not used in A3) |Parameter 6=
|p7= length (Optional): [[Number]] - optional, rope length in meters |=  
|p7= length (Optional): [[Number]] - optional, rope length in meters |Parameter 7=


| [[Object]] |= Return value
| [[Object]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________
|s2= '''ropeCreate''' [fromObject, fromPoint, length, segments, unroll] |= Syntax 2
|s2= [[ropeCreate]] [fromObject, fromPoint, length, segments, unroll] |Syntax 2=


|p21= [fromObject, fromPoint, lenght, segments, unroll]: [[Array]]
|p21= [fromObject, fromPoint, lenght, segments, unroll]: [[Array]] |Parameter 21=
|p22= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected |=
|p22= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected |Parameter 22=
|p23= 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) |=
|p23= 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) |Parameter 23=
|p24= length (Optional): [[Number]] - rope length |=
|p24= length (Optional): [[Number]] - rope length |Parameter 24=
|p25= segments (Optional): [[Number]] - define number of rope segments (not used in A3)|=
|p25= segments (Optional): [[Number]] - define number of rope segments (not used in A3)|Parameter 25=
|p26= unroll (Optional): [[Boolean]] - true if rope starts at one place and falls down unrolling itself, false to create it already in full length (default: false) (not used in A3) |=
|p26= unroll (Optional): [[Boolean]] - true if rope starts at one place and falls down unrolling itself, false to create it already in full length (default: false) (not used in A3) |Parameter 26=


|r2= [[Object]] |= Return value 2
|r2= [[Object]] |Return value 2=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1 = <code>myRope = [[ropeCreate]] <nowiki>[</nowiki>[[vehicle]] [[player]], "slingload0", myCargo, [0, 0, 0], 10]; //A3 example</code> |= Example 1
|x1 = <code>myRope = [[ropeCreate]] <nowiki>[</nowiki>[[vehicle]] [[player]], "slingload0", myCargo, [0, 0, 0], 10]; {{codecomment|// A3 example}}</code> |Example 1=
|x2 = <code>myRope = [[ropeCreate]] <nowiki>[</nowiki>[[vehicle]] [[player]], "fastrope0", 10, 10, [[true]]<nowiki>]</nowiki>; //TakeOn example</code> |= Example 2
|x2 = <code>myRope = [[ropeCreate]] <nowiki>[</nowiki>[[vehicle]] [[player]], "fastrope0", 10, 10, [[true]]<nowiki>]</nowiki>; {{codecomment|// TKOH example}}</code> |Example 2=
|x3 = <code>myRope = [[ropeCreate]] [veh1, [0,0,-2], veh2, [0,0,0], 10] //A3 1.34</code> |= Example 3
|x3 = <code>myRope = [[ropeCreate]] [veh1, [0,0,-2], veh2, [0,0,0], 10] {{codecomment|// A3 1.34}}</code> |Example 3=


| [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]], [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[ropeUnwind]] |= See also
| [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]], [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[ropeUnwind]] |See also=


}}
}}
Line 58: Line 58:
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Take_On_Helicopters:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Take_On_Helicopters:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Ropes and Sling Loading]]


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->

Revision as of 23:56, 29 March 2019


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

Description

Description:
Create a rope (PhysX rope in Arma 3).
Groups:
Uncategorised

Syntax

Syntax:
ropeCreate [fromObject, fromPoint, toObject, toPoint, segments, length]
Parameters:
[fromObject, fromPoint, toObject, toPoint, segments, length]: Array
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 (not used in A3)
length (Optional): Number - optional, rope length in meters
Return Value:
Object

Alternative Syntax

Syntax:
ropeCreate [fromObject, fromPoint, length, segments, unroll]
Parameters:
[fromObject, fromPoint, lenght, segments, unroll]: Array
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 (Optional): Number - rope length
segments (Optional): Number - define number of rope segments (not used in A3)
unroll (Optional): Boolean - true if rope starts at one place and falls down unrolling itself, false to create it already in full length (default: false) (not used in A3)
Return Value:
Object

Examples

Example 1:
myRope = ropeCreate [vehicle player, "slingload0", myCargo, [0, 0, 0], 10]; // A3 example
Example 2:
myRope = ropeCreate [vehicle player, "fastrope0", 10, 10, true]; // TKOH example
Example 3:
myRope = ropeCreate [veh1, [0,0,-2], veh2, [0,0,0], 10] // A3 1.34

Additional Information

See also:
ropeDestroyropeDetachropeSetCargoMassropescanSlingLoadenableRopeAttachgetSlingLoadropeAttachedObjectsropeAttachToropeLengthropeUnwoundropeAttachedToropeAttachEnabledropeCutropeEndPositionropeUnwind

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

Notes

Bottom Section

Posted on November 8, 2014 - 14:57 (UTC)
Tajin
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.
Posted on January 4, 2015 - 03:24 (UTC)
Feint
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.
Posted on July 9, 2015
Druid
Parameters segments and unroll are not supported in Arma 3. Segments are set automatically according the length of a rope.
Retrieved from "https://community.bistudio.com/wiki?title=ropeCreate&oldid=117121"