Skip to content

Commit

Permalink
[PHYSICS - DeleteRope]: Added Native Documentation (#1148)
Browse files Browse the repository at this point in the history
* docs(PHYSICS/DeleteRope): Updated DeleteRope Native

Renamed parameter, added description, and added code examples for Lua and C#

* chore(PHYSICS/DeleteRope): Updates and corrections based on review comments

Changed C# example to use native rope creation instead of wrapper

* chore(PHYSICS/DeleteRope): Fixed incorrect C# example

* chore(PHYSICS/DeleteRope): Update example based on review

Co-authored-by: Dillon Skaggs <[email protected]>

* tweak: update c# example for DeleteRope

- also switches the paramater name back to `ropeId` from `ropeHandle` to maintain consistency with other natives.

* Add missing using static call

* tweak: remove example and update docs slightly

---------

Co-authored-by: Dillon Skaggs <[email protected]>
Co-authored-by: Dillon Skaggs <[email protected]>
  • Loading branch information
3 people authored Aug 9, 2024
1 parent dcbcf9e commit 5b9708d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions PHYSICS/DeleteRope.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ ns: PHYSICS
void DELETE_ROPE(int* ropeId);
```
Deletes the rope with the specified handle.
## Parameters
* **ropeId**:
You should check if the rope exists before trying to delete it, see [DOES_ROPE_EXIST](#_0xFD5448BE3111ED96).
For an example on how to use this native please refer to [ADD_ROPE](#_0xE832D760399EB220)
## Parameters
* **ropeId**: The handle of the rope to delete

0 comments on commit 5b9708d

Please sign in to comment.