ropeCreate TKOH: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...) |
||
| Line 1: | Line 1: | ||
[[Category:Scripting Commands|ROPECREATE]] | [[Category:Scripting Commands|ROPECREATE]] | ||
{{Command | {{Command | ||
| TKOH | | TKOH | ||
|1.00 | |1.00 | ||
|gr1= Ropes and Sling Loading | |gr1= Ropes and Sling Loading | ||
| Creates a rope. For Arma 3 syntax see [[ropeCreate]]. | | Creates a rope. For Arma 3 syntax see [[ropeCreate]]. | ||
| '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, length] | | '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, length] | ||
|p1=[fromObject, fromPoint, toObject, toPoint, segments, length]: [[Array]] | |p1=[fromObject, fromPoint, toObject, toPoint, segments, length]: [[Array]] | ||
|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 | ||
|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). | ||
|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) | ||
|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) | ||
|p6= segments: [[Number]] - define number of segments to be created | |p6= segments: [[Number]] - define number of segments to be created | ||
|p7= length (Optional): [[Number]] - optional, rope length in meters | |p7= length (Optional): [[Number]] - optional, rope length in meters | ||
| [[Object]] | | [[Object]] | ||
|s2= '''ropeCreate''' [fromObject, fromPoint, length, segments, unroll] | |s2= '''ropeCreate''' [fromObject, fromPoint, length, segments, unroll] | ||
|p21= [fromObject, fromPoint, lenght, segments, unroll]: [[Array]] |Parameter 21= | |p21= [fromObject, fromPoint, lenght, segments, unroll]: [[Array]] |Parameter 21= | ||
| Line 31: | Line 31: | ||
|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= | |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]] | |r2= [[Object]] | ||
|x1 = <code>myRope = [[ropeCreate_TKOH |ropeCreate]] [<nowiki/>[[vehicle]] [[player]], "fastrope0", 10, 10, [[true]]<nowiki>]</nowiki>;</code> | |x1 = <code>myRope = [[ropeCreate_TKOH |ropeCreate]] [<nowiki/>[[vehicle]] [[player]], "fastrope0", 10, 10, [[true]]<nowiki>]</nowiki>;</code> | ||
| [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]] | | [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]] | ||
}} | }} | ||
Revision as of 12:05, 18 January 2021
Description
- Description:
- Creates a rope. For Arma 3 syntax see ropeCreate.
- Groups:
- Ropes and Sling Loading
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
- 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
- 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, "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