Page cover

🏠Recycling Locations

Define locations as recycling centers for players to visit and interact with

circle-check

The key is the zone name and must be unique, ensure this matches anywhere it is required

  • Set enabled to true to enable this location

  • Set debug to true to visually debug all target zones at this location

Config.Locations = {
    ['My Recycling Zone Name'] = { -- the key is the zone name
        enabled = true, -- enable this location
        debug = false, -- debug target zones
    },
}

circle-check

If required a cooldown can be set per location for recycling

  • Set enabled to true to enable cooldown at this location

  • Define the duration (time in seconds) for the cooldown period

Config.Locations = {
    ['My Recycling Zone Name'] = { -- the key is the zone name
        ---
        cooldown = { -- cooldown settings
            enabled = true, -- enable cooldown after searching to prevent spam
            duration = 5, -- time in seconds for cooldown if enabled to prevent spam
        },
        ---
    },
}

circle-check

If using an IPL or shell, you can set teleporting to locations at this recycling center

It is recommended to only use 1 location that teleports to an IPL, this is due to servers likely using the same IPL of a warehouse which is located under the docks, this could potentially clash with another location that uses the same IPL teleports so please bare this in mind.

  • Set enabled to true to use the teleport features

  • Set the entrance zone

  • Set the exit zone

  • Set the zone radius (default is 1.5)

  • Set the target interaction distance (default is 3.0)


circle-check

Define settings for searching recycling zones

  • Define the target icon

  • Define the target label

  • Define the target distance

  • Define the zone radius

  • Define the zone debug choice

  • Define locations (these must be vector3)

  • Define progressCircle settings

  • Define duration

  • Define label

  • Define animation settings

  • Define a list of props that are attached to the player if they find a recycle box to process

  • Define a list of objects that spawn inside (for empty shells)

  • Define a list of coordinates for those objects to spawn (must be vector4)

  • Follow the index number to add more


circle-check

Define settings for processing recycle boxes if found when searching

  • Coords must be vector3

  • Define target icon

  • Define target label

  • Define target distance

  • Define target zone radius

  • Define a prop if required

  • Set enabled to true to use a prop

  • Define the model and heading

  • Define progressCircle settings

  • Define the duration

  • Define the label

  • Define the animation settings

  • Define the rewards available

  • Name is the item name

  • Amount is the amount received (this is altered by level if using XP)


circle-check

Players can sell their items they have found from recycling or searching bins at their designated seller for this location

  • Define the ped model

  • Coords must be vector4

  • Define target icon

  • Define target label

  • Define target distance

  • Define animation scenario

  • Define blip settings if required

  • Define items available to sell and their prices

  • Name is item name

  • Price is the value PER unit of that item (multiplied by amount player chooses to sell)


circle-check

If defined for this location players can start garbage bag collection missions to earn extra cash

They must collect all the bags defined and then return to get paid / end round

  • Coords must be vector4

  • Define ped model

  • Define target icon

  • Define target label

  • Define target distance

  • Define animation scenario

  • Define blip settings if required

  • Define start mission coords (must be vector4)

  • Define the vehicle to be used for the collection missions

  • Define finish settings for payment amounts PER bag collected and payment type either 'CASH' or 'BANK'

  • Define locations for bags to spawn that must be collected

  • Coords must be vector4

  • To add more locations follow the correct index number


circle-check

Below is an example of a finished config file for a recycling center location

Last updated