Rope::deleteRope: Difference between revisions
(yay) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ClientsideJsFunction}} | |||
{{JSContainer| | |||
Deletes a created rope. | |||
=== Required Params === | |||
*'''handle:''' {{RageType|Handle}} | |||
=== Return Value === | |||
*'''void''' {{RageType|void}} | |||
==Syntax== | ==Syntax== | ||
< | <pre> | ||
mp.game.physics.deleteRope(handle); | |||
</pre> | |||
==Example== | ==Example== | ||
{{ClientsideCode| | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
// | 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> | </syntaxhighlight> | ||
}} | |||
}} | |||
==See also== | ==See also== | ||
{{ | {{Rope_functions_c}} | ||
[[Category:Clientside API]] | [[Category:Clientside API]] | ||
Latest revision as of 10:47, 12 May 2024
Client-Side Function
JavaScript Syntax
Deletes a created rope.
Required Params
- handle: Handle
Return Value
- void void
Syntax
mp.game.physics.deleteRope(handle);
Example
Client-Side
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!`);
See also
- mp.game.rope.addRope
- mp.game.rope.applyImpulseToCloth
- mp.game.rope.attachEntitiesToRope
- mp.game.rope.attachRopeToEntity
- mp.game.rope.breakEntityGlass
- mp.game.rope.deleteChildRope
- mp.game.rope.deleteRope
- mp.game.rope.detachRopeFromEntity
- mp.game.rope.doesRopeExist
- mp.game.rope.getCgoffset
- mp.game.rope.getRopeLastVertexCoord
- mp.game.rope.getRopeLength
- mp.game.rope.getRopeVertexCoord
- mp.game.rope.getRopeVertexCount
- mp.game.rope.loadRopeData
- mp.game.rope.pinRopeVertex
- mp.game.rope.ropeConvertToSimple
- mp.game.rope.ropeDrawShadowEnabled
- mp.game.rope.ropeForceLength
- mp.game.rope.ropeResetLength
- mp.game.rope.ropeSetUpdatePinverts
- mp.game.rope.setCgAtBoundcenter
- mp.game.rope.setCgoffset
- mp.game.rope.setDamping
- mp.game.rope.setDisableBreaking
- mp.game.rope.setDisableFragDamage
- mp.game.rope.startRopeUnwindingFront
- mp.game.rope.startRopeWinding
- mp.game.rope.stopRopeUnwindingFront
- mp.game.rope.stopRopeWinding
- mp.game.rope.unpinRopeVertex