NGD/ngddocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update ngd-detector

Browse Source
This commit is contained in:
Administrator 2025-02-21 19:29:51 -08:00 committed by DeLuce
parent 205326c1a2
commit 6d8f7ba43b
1 changed files with 50 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
ngd-detector.md
View File

@ -2,7 +2,7 @@
title: ngd-detector title: ngd-detector
description: description:
published: true published: true
date: 2025-02-22T03:20:43.944Z date: 2025-02-22T03:29:49.638Z
tags: tags:
editor: markdown editor: markdown
dateCreated: 2025-02-22T03:20:43.944Z dateCreated: 2025-02-22T03:20:43.944Z
@ -17,74 +17,65 @@ dateCreated: 2025-02-22T03:20:43.944Z
## Installation Steps ## Installation Steps
1. **Install ngd-Bridge** 1. ### **Install ngd-Bridge**
Follow the guide to install ngd-Bridge [HERE](https://nemesisdocs.com/en/gettingstarted). Follow the guide to install ngd-Bridge [HERE](https://nemesisdocs.com/en/gettingstarted).
2. **Install ngd-detector** 2. ### **Install ngd-detector**
Place `ngd-detector` into your **[ngd]** folder. This script must be started **after** `ngd-Bridge`. Place `ngd-detector` into your **[ngd]** folder. This script must be started **after** `ngd-Bridge`.
6. Add the items into your framework/inventory. 6. ### **Configure Detectors**.
<details> <details>
<summary><strong>Items List (OX)</strong> (Click to Expand)</summary> <summary><strong>Detector Config</strong> (Click to Expand)</summary>
-- There are two different types on config options for detectors.
- Config.PropDetectors will spawn in a prop and then have a configurable box zone over it.
- Config.ZoneDetectors will just use a boxzone, so you can put it over existing props in the map.
### See below for variables:
```lua ```lua
['ngd_suspiciousnote'] = { --Prop Detectors
label = 'Suspicious Note', Config.PropDetectors = {
weight = 0, [1] = {
stack = false, Coords = vector4(-540.8, -208.84, 37.65, 178.55), -- Coords of the prop
close = true, Prop = 'ngd_detector', -- Prop Name
description = '' BeepDistance = 8, -- Distance the detector alarm can be heard
}, Zone = {
['ngd_fakeidtoken'] = { Coords = vector3(-546.63, -201.32, 38.23), -- Coords of the boxzone
label = 'A Token Of Trust', Size = vector3(1, 1, 2), -- Size of the boxzone
weight = 0, Rotation = 210, -- Heading of the boxzone
stack = false, },
close = true, DetectItems = {
description = '' 'weapon_pistol', -- Item 'strings' that can be detected
}, 'weapon_smg'
['ngd_pbsecurity'] = { },
label = 'Forged Pillbox Security Card', Sounds = {
weight = 0, SoundSet = 'HUD_MINI_GAME_SOUNDSET', -- GTA Soundset
stack = false, SoundName = 'CHECKPOINT_MISSED' -- GTA Soundname
close = true, },
description = '' IgnoreJobs = {
}, Enabled = false, -- If true, the detector won't beep for the jobs below
['ngd_pbfreezerring'] = { Jobs = {
label = 'Mafia Family Ring', 'police', -- Job 'name'
weight = 0, 'taxi'
stack = false, }
close = true, },
description = '' Notify = {
}, Enabled = true, -- If true, will send notifications to the jobs below
``` Job = {
'police', -- Job 'name'
</details> 'taxi'
<details> },
<summary><strong>Items List (QB Format #1)</strong> (Click to Expand)</summary> Range = 20, -- Range that script will send notifications (such as a security system inside of a building)
Name = 'City Hall Front Door' -- Name of detector to show up in notification
```lua }
ngd_suspiciousnote = { name = 'ngd_suspiciousnote', label = 'Suspicious Note', weight = 0, type = 'item', image = 'ngd_suspiciousnote.png', unique = true, useable = true, shouldClose = false, combinable = nil, description = '' }, }
ngd_fakeidtoken = { name = 'ngd_fakeidtoken', label = 'A Token Of Trust', weight = 0, type = 'item', image = 'ngd_fakeidtoken.png', unique = false, useable = false, shouldClose = false, combinable = nil, description = '' }, }
ngd_pbsecurity = { name = 'ngd_pbsecurity', label = 'Forged Pillbox Security Card', weight = 0, type = 'item', image = 'ngd_pbsecurity.png', unique = false, useable = false, shouldClose = false, combinable = nil, description = '' },
ngd_pbfreezerring = { name = 'ngd_pbfreezerring', label = 'Mafia Family Ring', weight = 0, type = 'item', image = 'ngd_pbfreezerring.png', unique = false, useable = false, shouldClose = false, combinable = nil, description = '' },
```
</details>
<details>
<summary><strong>Items List (QB Format #2)</strong> (Click to Expand)</summary>
```lua
['ngd_suspiciousnote'] = { ['name'] = 'ngd_suspiciousnote', ['label'] = 'Suspicious Note', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_suspiciousnote.png', ['unique'] = true, ['useable'] = true, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
['ngd_fakeidtoken'] = { ['name'] = 'ngd_fakeidtoken', ['label'] = 'A Token Of Trust', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_fakeidtoken.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
['ngd_pbsecurity'] = { ['name'] = 'ngd_pbsecurity', ['label'] = 'Forged Pillbox Security Card', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_pbsecurity.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
['ngd_pbfreezerring'] = { ['name'] = 'ngd_pbfreezerring', ['label'] = 'Mafia Family Ring', ['weight'] = 0, ['type'] = 'item', ['image'] = 'ngd_pbfreezerring.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '' },
-- Config.ZoneDetectors have the same exact config, minus the prop logic.
``` ```
</details> </details>
--- ---
# Configuration Notes # Configuration Notes