Latest revision as of 10:47, 12 May 2024

Client-Side
Function

JavaScript

Deletes a created rope.

mp.game.physics.deleteRope(handle);

@@ Line 1: / Line 1: @@
+{{ClientsideJsFunction}}
+{{JSContainer|
+Deletes a created rope.
+=== Required Params ===
+*'''handle:''' {{RageType|Handle}}
+=== Return Value ===
+*'''void''' {{RageType|void}}
 ==Syntax==
-<syntaxhighlight lang="javascript">rope.deleteRope(rope);</syntaxhighlight>
+<pre>
-=== Required Arguments ===
+mp.game.physics.deleteRope(handle);
-*'''rope:''' Object
+</pre>
-===Return value===
-*'''Object'''
 ==Example==
+{{ClientsideCode|
 <syntaxhighlight lang="javascript">
-todo
+const {x, y, z} = mp.players.local.position;
+const forwardPos = mp.players.local.getForwardVector();
+//create a new rope
+const {result} = mp.game.physics.addRope(x, y, z, forwardPos.x, forwardPos.y, forwardPos.z, 50.0, 1, 50.0, 50.0, 1.2, false, true, true, 10.0, true, null);
+mp.console.logInfo(`Rope created! Handle: ${result}`);
+//delete created rope
+mp.game.physics.deleteRope(result);
+mp.console.logInfo(`Rope deleted!`);
 </syntaxhighlight>
+}}
+}}
 ==See also==
-{{Rope_function_c}}
+{{Rope_functions_c}}
 [[Category:Clientside API]]
-[[Category:TODO: Example]]