Benargee/Sandbox – User
Jump to navigation
Jump to search
m (→2) |
mNo edit summary |
||
Line 1: | Line 1: | ||
[[Category:Scripting Commands|ROPECREATE]] | |||
= | {{Command|= Comments | ||
____________________________________________________________________________________________ | |||
| TKOH |= Game name | |||
|1.00|= Game version | |||
| game2= arma3 |= | |||
|version2= dev|= <!-- user:Benargee dev 1.33 --> | |||
____________________________________________________________________________________________ | |||
| Create a rope. |= Description | |||
____________________________________________________________________________________________ | |||
| '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, (length)]|= Syntax | |||
|p1= fromObject: [[Object]] - object where rope starts and which fly behavior will be affected |= | |||
|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= toObject: [[Object]] - object which is automatically attached to other side of rope (can be objNull, rope will stay with free end) |= | |||
|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= segments: [[Number]] - define number of segments to be created |= | |||
|p6= length (Optional): [[Number]] - optional, rope length in meters |= | |||
| [[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> |= Example 1 | |||
|x2 = <code>myRope = [[ropeCreate]] <nowiki>[</nowiki>[[vehicle]] [[player]], "fastrope0", 10, 10, [[true]]<nowiki>]</nowiki>;</code> |= Example 2 | |||
|x3 = <code>myRope = [[ropeCreate]] [veh1, [0,0,-2], veh2, [0,0,0], 10]//A3 1.33</code> |= Example 3 | |||
| [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]] |= See also | |||
}} | |||
<h3 style="display:none">Notes</h3> | |||
<dl class="command_description"> | |||
<!-- Note Section BEGIN --> | |||
<!-- Note Section END --> | |||
</dl> | |||
<h3 style="display:none">Bottom Section</h3> | |||
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Take_On_Helicopters:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]] | |||
< | |||
} | |||
Revision as of 22:02, 13 October 2014
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];
- Example 3:
myRope = ropeCreate [veh1, [0,0,-2], veh2, [0,0,0], 10]//A3 1.33
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