destroyRope (VBS2)
From Bohemia Interactive Community
| Editors, please check Policy: Scripting Command Page Syntax. |
Click on the images for descriptions
Introduced in
- Game:
- Virtual Battlespace 2
- Version:
- 1.22
Description
- Description:
- Destroys a PhysX rope collection.
This function considers all objects that are connected via some joint with specified object (even mediately), considers those that are having the class name "ropeClassName" and removes them from the scene.
Syntax
- Syntax:
- destroyRope [ropedObject, ropeClassName]
- Parameters:
- ropedObject: Object - Object connected to rope to be destroyed
- ropeClassName: String - Name of class that represents a rope segment
- Return Value:
- Nothing
Examples
- Example 1:
destroyRope [ropeobj, "vbs2_rope_segment"]
Additional Information
- Multiplayer:
- Behaviour unknown.
- See also:
- createRope
