ropeCreate TKOH: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 2: Line 2:


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


| TKOH |Game name=
| TKOH |Game name=
Line 9: Line 8:
|gr1= Ropes and Sling Loading |GROUP1=
|gr1= Ropes and Sling Loading |GROUP1=


____________________________________________________________________________________________


| Creates a rope. For Arma 3 syntax see [[ropeCreate]]. |Description=
| Creates a rope. For Arma 3 syntax see [[ropeCreate]]. |Description=
____________________________________________________________________________________________


| '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, length] |Syntax=
| '''ropeCreate''' [fromObject, fromPoint, toObject, toPoint, segments, length] |Syntax=
Line 25: Line 22:


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


Line 36: Line 32:


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


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

Revision as of 02:15, 17 January 2021


Hover & click on the images for description

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

Notes

Bottom Section