ngddocs/ngd-detector.md

90 lines
2.7 KiB
Markdown
Raw Normal View History

2025-02-21 21:20:46 -06:00
---
title: ngd-detector
description:
published: true
2025-02-21 21:29:51 -06:00
date: 2025-02-22T03:29:49.638Z
2025-02-21 21:20:46 -06:00
tags:
editor: markdown
dateCreated: 2025-02-22T03:20:43.944Z
---
<div align="center">
<img src="/11f39c35-0150-4b61-b168-a61c673b9cce.png" alt="NGD Logo">
<h1><a href="https://store.nemesisgd.com/package/6124798" target="_blank">NGD-DETECTOR</a></h1>
</div>
## Installation Steps
2025-02-21 21:29:51 -06:00
1. ### **Install ngd-Bridge**
2025-02-21 21:20:46 -06:00
Follow the guide to install ngd-Bridge [HERE](https://nemesisdocs.com/en/gettingstarted).
2025-02-21 21:29:51 -06:00
2. ### **Install ngd-detector**
2025-02-21 21:20:46 -06:00
Place `ngd-detector` into your **[ngd]** folder. This script must be started **after** `ngd-Bridge`.
2025-02-21 21:29:51 -06:00
6. ### **Configure Detectors**.
2025-02-21 21:20:46 -06:00
<details>
2025-02-21 21:29:51 -06:00
<summary><strong>Detector Config</strong> (Click to Expand)</summary>
2025-02-21 21:20:46 -06:00
2025-02-21 21:29:51 -06:00
-- 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.
2025-02-21 21:20:46 -06:00
2025-02-21 21:29:51 -06:00
### See below for variables:
2025-02-21 21:20:46 -06:00
```lua
2025-02-21 21:29:51 -06:00
--Prop Detectors
Config.PropDetectors = {
[1] = {
Coords = vector4(-540.8, -208.84, 37.65, 178.55), -- Coords of the prop
Prop = 'ngd_detector', -- Prop Name
BeepDistance = 8, -- Distance the detector alarm can be heard
Zone = {
Coords = vector3(-546.63, -201.32, 38.23), -- Coords of the boxzone
Size = vector3(1, 1, 2), -- Size of the boxzone
Rotation = 210, -- Heading of the boxzone
},
DetectItems = {
'weapon_pistol', -- Item 'strings' that can be detected
'weapon_smg'
},
Sounds = {
SoundSet = 'HUD_MINI_GAME_SOUNDSET', -- GTA Soundset
SoundName = 'CHECKPOINT_MISSED' -- GTA Soundname
},
IgnoreJobs = {
Enabled = false, -- If true, the detector won't beep for the jobs below
Jobs = {
'police', -- Job 'name'
'taxi'
}
},
Notify = {
Enabled = true, -- If true, will send notifications to the jobs below
Job = {
'police', -- Job 'name'
'taxi'
},
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
}
}
}
-- Config.ZoneDetectors have the same exact config, minus the prop logic.
2025-02-21 21:20:46 -06:00
```
</details>
---
# Configuration Notes
- **Extensive Configuration Options**
Open and configure all the `Config` files to match your server's settings.
> Do you still need help? Open a ticket in our [Discord](https://discord.gg/AnXx2GVGcM)
{.is-warning}