-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(natives/object): add documentation for DELETE_OBJECT (#1163)
* feat(natives/object): add documentation for DELETE_OBJECT * Add documentation for DELETE_OBJECT * Add examples (Lua, JS, C#) * A note about some entites who can't be deleted Co-Authored-By: Dillon Skaggs <[email protected]> * Fix code examples --------- Co-authored-by: Dillon Skaggs <[email protected]>
- Loading branch information
1 parent
830e31d
commit 331a50c
Showing
1 changed file
with
71 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,71 @@ | ||
--- | ||
ns: OBJECT | ||
--- | ||
## DELETE_OBJECT | ||
|
||
```c | ||
// 0x539E0AE3E6634B9F 0xD6EF9DA7 | ||
void DELETE_OBJECT(Object* object); | ||
``` | ||
``` | ||
Deletes the specified object, then sets the handle pointed to by the pointer to NULL. | ||
``` | ||
## Parameters | ||
* **object**: | ||
--- | ||
ns: OBJECT | ||
--- | ||
## DELETE_OBJECT | ||
|
||
```c | ||
// 0x539E0AE3E6634B9F 0xD6EF9DA7 | ||
void DELETE_OBJECT(Object* object); | ||
``` | ||
Deletes the specified object. | ||
**Note**: If for some reason the entity won't delete, you might want to check if the object is a mission entity. | ||
``` | ||
NativeDB Introduced: v323 | ||
``` | ||
## Parameters | ||
* **object**: The object you want to delete. | ||
## Examples | ||
```lua | ||
local playerPed = PlayerPedId() | ||
local playerCoords = GetEntityCoords(playerPed) | ||
local objectHash = GetHashKey("v_ret_gc_chair03") | ||
local object = GetClosestObjectOfType(playerCoords, 10.0, objectHash, true, false, false) | ||
if object == 0 then return end | ||
-- If the object is a mission entity, we have to set it to false. Otherwise, it won't be possible to delete the object. | ||
if IsEntityAMissionEntity(object) then | ||
SetEntityAsMissionEntity(object, false, true) | ||
end | ||
DeleteObject(object) | ||
``` | ||
|
||
```js | ||
const playerPed = PlayerPedId(); | ||
const playerCoords = GetEntityCoords(playerPed, false); | ||
const objectHash = GetHashKey("v_ret_gc_chair03"); | ||
|
||
const object = GetClosestObjectOfType(playerCoords[0], playerCoords[1], playerCoords[2], 10.0, objectHash, true, false, false); | ||
if (object === 0) return; | ||
|
||
// If the object is a mission entity, we have to set it to false. Otherwise, it won't be possible to delete the object. | ||
if (IsEntityAMissionEntity(object)) { | ||
SetEntityAsMissionEntity(object, false, true); | ||
} | ||
|
||
DeleteObject(object); | ||
``` | ||
|
||
```csharp | ||
using static CitizenFX.Core.Native.API; | ||
|
||
int playerPed = PlayerPedId(); | ||
Vector3 playerCoords = GetEntityCoords(playerPed, false); | ||
uint objectHash = Game.GenerateHashASCII("v_ret_gc_chair03"); | ||
|
||
int prop = GetClosestObjectOfType(playerCoords.X, playerCoords.Y, playerCoords.Z, 10.0f, objectHash, true, false, false); | ||
if (prop == 0) return; | ||
// If the object is a mission entity, we have to set it to false. Otherwise, it won't be possible to delete the object. | ||
if (IsEntityAMissionEntity(prop)) | ||
{ | ||
SetEntityAsMissionEntity(prop, false, true); | ||
} | ||
|
||
DeleteObject(ref prop); | ||
``` |