ev_garbagesave

EV_GARBAGESAVE is a custom made ressource. Completely edited and changed to work properly and optimized.

EV Garbage System

The EV Garbage System introduces interactive dumpsters into your FiveM server, allowing players to throw away or retrieve items. This system uses ox_target, ox_inventory, and integrates with a database to manage unique stashes for each dumpster.

---

Configuration

The configuration defines the dumpster models, inventory attributes, and other parameters.

Dumpster Models

Defines the dumpster models that players can interact with.

Config.DumpsterModels = {
    GetHashKey('prop_dumpster_01a'),
    GetHashKey('prop_dumpster_02a'),
    GetHashKey('prop_dumpster_02b'),
    GetHashKey('prop_dumpster_3a'),
    GetHashKey('prop_dumpster_4a'),
    GetHashKey('prop_dumpster_4b')
}

Dumpster Attributes

Defines inventory settings for dumpsters.

Config.DumpsterAttributes = {
    slots = 60,           -- Maximum number of slots in the dumpster inventory
    maxWeight = 200000    -- Maximum weight (in grams) allowed in the dumpster inventory
}

---

Client-Side Functionality

ox_target Integration

The system uses ox_target to allow interaction with dumpsters.

exports.ox_target:addModel(Config.DumpsterModels, {
    name = targetName,
    label = "Throw something away",
    event = "ev_garbage:openTrashInventory",
    icon = 'fa-solid fa-trash-can',
    distance = 2.0,
    onSelect = function(data)
        local binEntity = data.entity
        local coords = GetEntityCoords(binEntity)
        coords = vector3(math.floor(coords.x), math.floor(coords.y), math.floor(coords.z))
        local stashName = "trash_" .. tostring(binEntity)
        
        TriggerServerEvent('ev_garbage:openStashServer', stashName, coords)
    end
})

This allows players to interact with dumpsters and opens the relevant stash inventory.

---

Client Events

Open Dumpster Stash

Triggered by the server when a stash is found or registered.

RegisterNetEvent('ev_garbage:openStashClient', function(stash)
    if exports.ox_inventory:openInventory('stash', stash) == false then
        TriggerServerEvent('ev_garbage:lazyRegisterStash', stash)
    end
end)

---

Server-Side Functionality

Registering a Stash

Registers a unique stash for a dumpster.

function oxRegisterStash(stashName)
    local stash = {
        id = stashName,
        label = "Garbage",
        slots = Config.DumpsterAttributes.slots,
        weight = Config.DumpsterAttributes.maxWeight
    }

    exports.ox_inventory:RegisterStash(stash.id, stash.label, stash.slots, stash.weight, false)
end

---

Database Management

Database Initialization

Creates a database table to track dumpsters.

AddEventHandler('onResourceStart', function(resourceName)
    if GetCurrentResourceName() ~= resourceName then
        return
    end

    MySQL.query([[
        CREATE TABLE IF NOT EXISTS `garbage_bins` (
            `id` INT AUTO_INCREMENT PRIMARY KEY,
            `stash` VARCHAR(100) NOT NULL,
            `xCoord` INT(50) NOT NULL,
            `yCoord` INT(50) NOT NULL,
            `zCoord` INT(50) NOT NULL
        );
    ]], {}, function(affectedRows)
        print("Dumpster database ready")
    end)
end)

---

Handle Stash Opening

Checks if a dumpster has an existing stash or creates a new one.

RegisterNetEvent('ev_garbage:openStashServer', function(stashName, coords)
    local src = source
    
    MySQL.query('SELECT * FROM garbage_bins WHERE xCoord = ? AND yCoord = ? AND zCoord = ?', 
        {coords.x, coords.y, coords.z}, 
        function(result)
            if #result > 0 then
                local existingStashName = result[1].stash

                TriggerClientEvent('ev_garbage:openStashClient', src, existingStashName)
            else
                oxRegisterStash(stashName)

                MySQL.query('INSERT INTO garbage_bins (stash, xCoord, yCoord, zCoord) VALUES (?, ?, ?, ?)', {
                    stashName,
                    coords.x,
                    coords.y,
                    coords.z
                })
                
                TriggerClientEvent('ev_garbage:openStashClient', src, stashName)
            end  
        end)
end)

---

Lazy Register Stash

Registers a stash on-the-fly if it doesn’t already exist.

RegisterNetEvent('ev_garbage:lazyRegisterStash', function(stash)
    local src = source

    oxRegisterStash(stash)
    TriggerClientEvent('ev_garbage:openStashClient', src, stash)
end)

---

Usage Guide

Player Interaction

1. Approach a dumpster that is part of the Config.DumpsterModels list.

2. Use the ox_target interaction labeled "Throw something away."

3. The system will:

   • Check if a stash already exists for the selected dumpster.

   • Open the relevant stash inventory for interaction.

---

Developer Notes

1. Database Integration: Ensure your database is properly configured to support the garbage_bins table.

2. Stash Management: All stashes are uniquely linked to dumpster coordinates, ensuring persistent storage.

3. Custom Models: Add additional dumpster models to Config.DumpsterModels as needed.

4. Inventory: Ensure ox_inventory is properly installed and configured.

---

Example Scenarios

Scenario 1: Existing Dumpster

• A player interacts with a dumpster that already has a stash.

• The system retrieves the stash from the database and opens it.

Scenario 2: New Dumpster

• A player interacts with a dumpster that doesn’t have a stash.

• The system registers a new stash, saves it in the database, and opens it for the player.

---