ropeCreate TKOH: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
m (Some wiki formatting)
Line 1: Line 1:
[[Category:Scripting Commands|ROPECREATE]]
{{RV|type=command


{{RV|type=command
|game1= tkoh


| TKOH
|version1= 1.00
|1.00


|gr1= Ropes and Sling Loading
|gr1= Ropes and Sling Loading


| Creates a rope. For Arma 3 syntax see [[ropeCreate]].
|descr= Creates a rope.
 
{{Feature|arma3|This command syntax is for {{tkoh}} only. For {{arma3}}, see [[ropeCreate]].}}
 
|s1= [[ropeCreate]] [fromObject, fromPoint, toObject, toPoint, segments, length]


| '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, length]
|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


|p1=[fromObject, fromPoint, toObject, toPoint, segments, length]: [[Array]]
|r1= [[Object]]
|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).
|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)
|p6= segments: [[Number]] - define number of segments to be created
|p7= length (Optional): [[Number]] - optional, rope length in meters


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


|p21= [fromObject, fromPoint, lenght, segments, unroll]: [[Array]]
|p21= 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
|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= 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= length (Optional): [[Number]] - rope length
|p24= length (Optional): [[Number]] - rope length
|p24= segments (Optional): [[Number]] - define number of rope segments
|p25= segments (Optional): [[Number]] - define number of rope segments
|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)
|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)


|r2= [[Object]]
|r2= [[Object]]


|x1 = <code>myRope = [[ropeCreate_TKOH |ropeCreate]] [<nowiki/>[[vehicle]] [[player]], "fastrope0", 10, 10, [[true]]<nowiki>]</nowiki>;</code>
|x1= <code>myRope = [[{{PAGENAME}}|ropeCreate]] [<nowiki/>[[vehicle]] [[player]], "fastrope0", 10, 10, [[true]]];</code>


| [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]]
|seealso= [[ropeCreate|ropeCreate ({{arma3}})]], [[ropeDestroy]], [[ropeDetach]], [[ropeSetCargoMass]]
}}
}}
{{GameCategory|tkoh|Scripting Commands}}
<!-- CONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 00:19, 31 January 2021

tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
Creates a rope.
Arma 3
This command syntax is for Take On Helicopters only. For Arma 3, see ropeCreate.
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 (Optional): Number - optional, rope length in meters
Return Value:
Object

Alternative Syntax

Syntax:
ropeCreate [fromObject, fromPoint, length, 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)
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)
Return Value:
Object

Examples

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

Additional Information

See also:
ropeCreate (Arma 3)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
Retrieved from "https://community.bistudio.com/wiki?title=ropeCreate_TKOH&oldid=225767"