ropeCreate TKOH: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 19: Line 19:
|p4= toObject: [[Object]] - object which is automatically attached to other side of rope (can be objNull, rope will stay with free end) |Parameter 4=
|p4= toObject: [[Object]] - object which is automatically attached to other side of rope (can be objNull, rope will stay with free end) |Parameter 4=
|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) |Parameter 5=
|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) |Parameter 5=
|p6= segments: [[Number]] - define number of segments to be created (not used in A3) |Parameter 6=
|p6= segments: [[Number]] - define number of segments to be created |Parameter 6=
|p7= length (Optional): [[Number]] - optional, rope length in meters |Parameter 7=
|p7= length (Optional): [[Number]] - optional, rope length in meters |Parameter 7=


Line 30: Line 30:
|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) |Parameter 23=
|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) |Parameter 23=
|p24= length (Optional): [[Number]] - rope length |Parameter 24=
|p24= length (Optional): [[Number]] - rope length |Parameter 24=
|p25= segments (Optional): [[Number]] - define number of rope segments (not used in A3)|Parameter 25=
|p25= segments (Optional): [[Number]] - define number of rope segments|Parameter 25=
|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=



Revision as of 17:25, 1 September 2019


Hover & click on the images for description

Description

Description:
Creates a rope. For Arma 3 syntax see ropeCreate.
Groups:
Uncategorised

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