ropeCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Create a rope between two given objects. |= Description
| Create a rope. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Rope]] <nowiki>=</nowiki>  '''ropeCreate''' [firstObject, relPosition1, secondObject, relPosition2, segmentCount (, length)]|= Syntax
| '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, (length)]|= Syntax


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


| [[Rope]] |= Return value
| [[Object]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
|s2= '''ropeCreate''' [fromObject, fromPoint, lenght, (segments, unroll)]; |= Syntax 2
|p21= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected |=
|p22= 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= segments: [[Number]] - define number of rope segments |=
|p24= length (Optional): [[Number]] - optional, rope length |=
|p25= 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) |=
|r2= [[Object]] |= Return value 2
____________________________________________________________________________________________
|x1 = <code>myRope = ropecreate <nowiki>[</nowiki>[[vehicle]] [[player]],"slingload0",myCargo,[0,0,0],10];</code> |=
|x2 = <code>myRope = ropecreate <nowiki>[</nowiki>[[vehicle]] [[player]],"fastrope0",10,10,true];</code> |=


| [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]] |= See also
| [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]] |= See also
Line 37: Line 51:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Take_On_Helicopters:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]

Revision as of 12:14, 2 November 2011


Hover & click on the images for description

Description

Description:
Create a rope.
Groups:
Uncategorised

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 (Optional): Number - optional, rope length in meters
Return Value:
Object

Alternative Syntax

Syntax:
ropeCreate [fromObject, fromPoint, lenght, (segments, unroll)];
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)
segments: Number - define number of rope segments
length (Optional): Number - optional, rope length
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)
Return Value:
Object

Examples

Example 1:
myRope = ropecreate [vehicle player,"slingload0",myCargo,[0,0,0],10];
Example 2:
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

Notes

Bottom Section