# Items

## Items

**Inventory Item Configuration**

Update your inventory configuration by adding the following items required for the various cleaning missions (Window Cleaning, General Cleaning, Street Cleaning, etc).

#### Required Items Overview

| Item Name               | Label              | Description                                                      |
| ----------------------- | ------------------ | ---------------------------------------------------------------- |
| `trash_grabber`         | Trash Grabber Kit  | Used during trash collection missions. Equips grabber + bin bag. |
| `cleaning_water_gun`    | Cleaning Water Gun | Used during window cleaning missions. Equips spray gun.          |
| `window_cleaning_drone` | Cleaning Drone     | Used during drone cleaning missions.                             |
| `window_squeegee`       | Window Squeegee    | Used during window cleaning missions. Equips squeegee.           |
| `cleaning_broom`        | Cleaning Broom     | Used during street cleaning missions. Equips broom.              |

***

#### QBCore / ESX Setup

Add the following items to your shared items configuration file (e.g., `qb-core/shared/items.lua` or your framework's equivalent):

```
qb-core/shared/items.lua
```

```lua
trash_grabber             = { name = 'trash_grabber',             label = 'Trash Grabber Kit',     weight = 500,  type = 'item', image = 'trash_grabber.png',         unique = false, useable = true, shouldClose = true, description = 'Equipment for trash collection missions' },
cleaning_water_gun        = { name = 'cleaning_water_gun',        label = 'Cleaning Water Gun',    weight = 1000, type = 'item', image = 'cleaning_water_gun.png',    unique = false, useable = true, shouldClose = true, description = 'Water gun for window cleaning missions' },
window_cleaning_drone     = { name = 'window_cleaning_drone',     label = 'Cleaning Drone',        weight = 2000, type = 'item', image = 'window_cleaning_drone.png', unique = false, useable = true, shouldClose = true, description = 'Drone for cleaning missions' },
window_squeegee           = { name = 'window_squeegee',           label = 'Window Squeegee',       weight = 500,  type = 'item', image = 'window_squeegee.png',       unique = false, useable = true, shouldClose = true, description = 'Squeegee for window cleaning missions' },
cleaning_broom            = { name = 'cleaning_broom',            label = 'Cleaning Broom',        weight = 1000, type = 'item', image = 'cleaning_broom.png',        unique = false, useable = true, shouldClose = true, description = 'Broom for street cleaning' },
```

> **Note:** Don't forget to extract the images from the script's `images/` directory and place them into your inventory resources (e.g., `qb-inventory/html/images/`).

***

#### QBox & OX Inventory Setup

If you are using `ox_inventory`, add these items to your `ox_inventory/data/items.lua`:

```
ox_inventory/data/items.lua
```

```lua
['trash_grabber'] = {
    label = 'Trash Grabber Kit',
    weight = 500,
    stack = true,
    close = true,
    description = 'Equipment for trash collection missions',
},

['cleaning_water_gun'] = {
    label = 'Cleaning Water Gun',
    weight = 1000,
    stack = true,
    close = true,
    description = 'Water gun for window cleaning missions',
},

['window_cleaning_drone'] = {
    label = 'Cleaning Drone',
    weight = 2000,
    stack = true,
    close = true,
    description = 'Drone for cleaning missions',
},

['window_squeegee'] = {
    label = 'Window Squeegee',
    weight = 500,
    stack = true,
    close = true,
    description = 'Squeegee for window cleaning missions',
},

['cleaning_broom'] = {
    label = 'Cleaning Broom',
    weight = 1000,
    stack = true,
    close = true,
    description = 'Broom for street cleaning',
},
```

***

#### Item Behavior Details

* **Trash Grabber Kit (`trash_grabber`)**
  * ✅ Used during mission → Equips grabber tool + bin bag in hands.
  * ❌ Used outside mission → "You are not on a mission!" warning.
  * 🗑️ Mission ends → Automatically removed from inventory (if the script expects temporary equipment).
* **Cleaning Water Gun (`cleaning_water_gun`)**
  * ✅ Used during mission → Activates water gun.
* **Cleaning Broom (`cleaning_broom`)**
  * ✅ Used during mission → Equips/Unequips broom prop.

> \[!NOTE] Ensure that item strings in your [shared/config.lua](file:///c:/FrknEsx/txData/ESXLegacy_E7A565.base/resources/\[frkn]/frkn-cleanjob/shared/config.lua) match the item names exactly as you've defined them in your inventory.