🪣Envi-Dumpsters

Envi-Dumpsters Official Documentation

Preview

Prerequisites

• A working FiveM Server

• Basic understanding of FiveM server setup and resource management

• An up-to-date version of ox_lib

Config Preview

21KB

config.lua

1. General Settings

Config.DebugMode

• Type: Boolean

• Default: false

• Description: Enable or disable debug messages. Set to true for debugging purposes.

Config.TrashCooldown

• Type: Number

• Default: 10

• Description: The time in minutes a player must wait before they can search the same trash again.

Config.AdvancedCheaterCheck

• Type: Boolean

• Default: true

• Description: Enable or disable the advanced cheater check. Note: WaveShield may have issues with this feature.

Config.JobLocked

• Type: Boolean or Table

• Default: false

• Description: Lock the trash functionality to specific jobs. Set to true to enable job locking, or provide a table of job names (e.g., {'job1', 'job2', 'job3'}).

Config.StashesEnabled

• Type: Boolean

• Default: true

• Description: Enable or disable the stashes feature.

Config.HideInDumpstersEnabled

• Type: Boolean

• Default: true

• Description: Enable or disable the hide in dumpster feature.

Config.LeaveDumpsterHeight

• Type: Number

• Default: 1.80

• Description: Added height value when leaving dumpster. Useful for servers with issues of players getting stuck or falling through the floor when leaving dumpsters.

Config.ProgressBars

• Type: Boolean

• Default: false

• Description: Enable or disable progress bars. Note: This feature is a work in progress and may be buggy.

2. Fail Settings

Config.Fails

• Type: Table

• Description: Contains all settings related to fail events during trash searching.

EnableFail

• Type: Boolean

• Default: true

• Description: Enable or disable the fail mechanism.

EnableRatEvent

• Type: Boolean

• Default: true

• Description: Enable or disable rat events during fails.

EnableNeedleEvent

• Type: Boolean

• Default: true

• Description: Enable or disable needle events during fails.

FailChancePercent

• Type: Number

• Default: 13

• Description: The probability, as a percentage, that a player will fail when attempting to search the trash.

DirtyNeedlesChancePercent

• Type: Number

• Default: 50

• Description: The chance, as a percentage, of encountering dirty needles when a failure occurs.

DirtyNeedlesEffectTime

• Type: Number

• Default: 90

• Description: The time, in seconds, that the dirty needles effect will last.

RatChancePercent

• Type: Number

• Default: 50

• Description: The chance, as a percentage, of encountering a rat when a failure occurs.

DirtyNeedlesHealthLoss

• Type: Number

• Default: 20

• Description: The amount of health a player will lose if affected by the dirty needles event.

HealthLoss

• Type: Number

• Default: 10

• Description: The fixed amount of health a player will lose on a generic fail event.

RatHealthLoss

• Type: Number

• Default: 5

• Description: The fixed amount of health a player will lose if affected by the rat event.

3. Aggressive Ped Settings

Config.AggressivePedsAttack

• Type: Boolean

• Default: true

• Description: Enable or disable hostile hobo events.

Config.AggressivePedDistance

• Type: Number

• Default: 25

• Description: The distance, in meters, that a player must be from a hobo before they become hostile.

Config.AggressivePeds

• Type: Table

• Description: List of ped models that can become aggressive.

4. Rewards Settings

Config.RandomSelection

• Type: Table

• Description: Configuration for the random item selection.

itemCountMin

• Type: Number

• Default: 1

• Description: Minimum number of items to select randomly.

itemCountMax

• Type: Number

• Default: 5

• Description: Maximum number of items to select randomly.

Item Tables

• Config.BeachCanItems

• Config.BeachCanItemsRare

• Config.DumpsterItems

• Config.DumpsterItemsRare

• Config.GarbageCanItems

• Config.GarbageCanItemsRare

• Config.OtherSeachablesItems

• Config.OtherSeachablesItemsRare

• Config.GarbageBagsItems

• Config.GarbageBagsItemsRare

Each table contains items that can be found in different types of trash containers. Each item has a name, metadata, and min/max quantities.

Rare Item Chance Settings

• Config.BeachCanItemsRareChance

• Config.DumpsterItemsRareChance

• Config.GarbageCanItemsRareChance

• Config.OtherSeachablesItemsRareChance

• Config.GarbageBagsItemsRareChance

These settings determine the chance, as a percentage, of finding an extra rare item in each type of container.

5. Storage Settings

Beach Can Storage

• Config.BeachCanStorageSlots: Number of slots in beach can storage

• Config.BeachCanStorageWeight: Maximum weight of beach can storage

Dumpster Storage

• Config.DumpsterStorageSlots: Number of slots in dumpster storage

• Config.DumpsterStorageWeight: Maximum weight of dumpster storage

Garbage Can Storage

• Config.GarbageCanStorageSlots: Number of slots in garbage can storage

• Config.GarbageCanStorageWeight: Maximum weight of garbage can storage

Other Storage

• Config.OtherStorageSlots: Number of slots in other storage

• Config.OtherStorageWeight: Maximum weight of other storage

6. Exclusive Item Zones

Config.ExclusiveItemZones

• Type: Table

• Description: Defines zones where specific items can be found.

Each zone has the following properties:

• name: Unique name for the zone

• coords: Vector3 coordinates of the zone center

• radius: Radius of the zone

• chance: Chance of finding these items in this area

• restrictedZone: If true, there's a chance police will be called

• snitchChance: Chance that a snitch will call the police/employees

• jobsToInform: Jobs to inform if a snitch calls

• items: Table of items that can be found in this zone

7. Target Models

• BeachCans: Models for beach trash cans

• Dumpsters: Models for dumpsters

• GarbageCans: Models for garbage cans

• OtherSearchables: Models for other searchable objects

• TrashBagModels: Models for trash bags

8. Animation Settings

• Config.RatFailAnim: Animation for rat fail event

• Config.DirtyNeedlesFailAnim: Animation for dirty needles fail event

• Config.FailAnim: Animation for generic fail event

• BeachCanAnims: Animations for searching beach cans

• DumpsterAnims: Animations for searching dumpsters

• GarbageCanAnims: Animations for searching garbage cans

• TrashBagAnims: Animations for searching trash bags

• HideInDumpsterAnims: Animations for hiding in dumpsters

• KickedOutDumpsterAnims: Animations for being kicked out of dumpsters

Config.GetOutKey

• Type: Number

• Default: 73

• Description: The key to get out of the dumpster while hiding inside (Default: X)

9. Language Settings

Config.Lang

• Type: Table

• Description: Contains all language strings used in the script.

10. Stopping ox target for dumpsters

go to modules/inventory/client.lua - around line 79

if shared.target then
    -- exports.ox_target:addModel(Inventory.Dumpsters, {
    --     icon = 'fas fa-dumpster',
    --     label = locale('search_dumpster'),
    --     onSelect = function(data) return Inventory.OpenDumpster(data.entity) end,
    --     distance = 2
    -- })

    exports.ox_target:addGlobalVehicle({
        icon = 'fas fa-truck-ramp-box',
        label = locale('open_label', locale('storage')),
        distance = 1.5,
        canInteract = Inventory.CanAccessTrunk,
        onSelect = function(data)
            return Inventory.OpenTrunk(data.entity)
        end
    })
else
    -- local dumpsters = table.create(0, #Inventory.Dumpsters)

    -- for i = 1, #Inventory.Dumpsters do
    --     dumpsters[Inventory.Dumpsters[i]] = true
    -- end

    -- Inventory.Dumpsters = dumpsters
end

Key language strings include messages for various events, prompts, and notifications related to trash searching and dumpster interactions.