Weed Type

All weed actions are formated as an array containing objects with the following properties.

Blip

Adding blip to the center coordinate of stage zone. Not required

Property	Type	Default	Description
active	boolean	false	Blip will show or hide
scale	number	0.85	Scale of the blip
color	number	0	Color of the blip
sprite	number	469	Sprite ID of the blip
text	string	nil	Text displayed on the blip

Prop

Prop to be added to the pad's hand when playing animation. Not Required

If you want to define multiple props, you can pass them as individual tables (array of objects)

Property	Type	Default
model	hash	required
bone	number	60309
pos	vector3	required
rot	vector3	required
rotOrder	number	0

Animation

Defines animation settings for interactions. Animations Not Required

Property	Type	Default	Description
dict	string	required	Animation dictionary.
clip	string	required	Animation clip.
flag	number	0	Animation flag.
prop	Prop	nil	Prop settings for the animation.
scenario	string	nil	Must specify either scenario or dict.

Object

Defines an in-game object. Objects Not Required

Property	Type	Default	Description
model	string	required	Model of the object.
rotation	vector3	required	Rotation of the object.
offset	vector3	nil	Offset of the object.
respawnTime	number	nil	After interacting with the object, the object will be deleted and will recreated at the end of the time

OnCompleted

Defines actions that occur upon completion of an interaction. Not required

Property	Type	Description
giveItems	string | string[] | table<string, number>	Items to give on completion.
removeItems	string | string[] | table<string, number>	Items to remove on completion.
exp	number	Experience points to stage on completion.

CanInteract

Defines conditions required to interact with an option. Not Required

Property	Type	Description
items	string | string[] | table<string, number>	Items required to interact.
job	string | string[] | table<string, number>	Jobs allowed to interact.
level	number	Minimum level required.
reputationLevel	number	Minimum reputation level required.
requiredPoliceCount	number	Number of police needed for this option.

Options

Defines interaction options for a stage.

• icon value applies to font-awesome
• if you set a minigame, the ox_progressbar will appear and prompt you to press [E] 3 times in the correct position

• policeAlertChange, probability to notify police when target is completed

Property	Type	Description
label	string	Label for the interaction option.
icon	string	Icon for the interaction option.
minigame	boolean	Whether a minigame is required.
duration	number	Duration of the interaction in milliseconds.
animation	Animation	Animation to play during interaction.
onCompleted	OnCompleted	Actions to perform on completion.
canInteract	CanInteract	Conditions to allow interaction.
cooldown	number	Cooldown time in milliseconds.
policeAlertChange	number	Percentage chance of alerting police.

OnItemUsed

Defines actions triggered when an useableItem is used. Not Required

• When using an item you can trigger an event or simulate an option

Property	Type	Description
event	string	Client-side event name.
serverEvent	string	Server-side event name.
simulateOption	number | string	Option table key.

WeedStage

Defines a stage in the weed processing system.

• If you set useableItem, onItemUsed will be triggered when you use that item. You may prefer this for operations like rolling for example.

• zones are required if no useableItem. Each added zone will be checked separately for all processes. You can add as many as you want.

• If you set the radius value, the object will spawn at a random position inside that zone. radius is not required and if not set, the object will spawn at the exact position of the zones

• Options are the options you will see when you interact with the object with target

Property	Type	Description
active	boolean	Whether the stage is active (default: true).
label	string	Descriptive label for the stage.
blip	Blip	Blip settings for the stage.
zones	table<key, vector3> required	Zones where the stage can be performed.
radius	number	Radius for random object placement.
object	Object	Object to be spawned in the zone.
options	table<key, Options>	Interaction options for the stage.
useableItem	string Not Required	Item required for interaction. item name
onItemUsed	OnItemUsed	Actions to perform when using the useableItem.

Weed

Defines a type of weed and its processing stages.

Property	Type	Description
active	boolean	Whether the weed type is active (default: true).
label	string	Descriptive label for the weed.
imagePath	string	Image for UI.
description	string	Description of the weed type.
stages	table<key, WeedStage>	Stages for processing the weed.

---

Examples

#1

[1] = {
    label = 'Sativa',
    description = 'Harvest, process, roll and deliver orders',
    imagePath = 'sativa_leaf.png',
    stages = {
        [1] = {
            label = 'Harvesting',
            blip = { active = true, color = 5, sprite = 469 },
            zones = {
                vector3(2852.3779, 4585.1973, 46.1),
                vector3(2849.0, 4577.0, 46.1),
                vector3(2849.0, 4577.0, 47.0),
                vector3(2845.0, 4588.0, 47.0),
                vector3(2862.9404, 4582.7388, 47.4004),
                vector3(2882.1274, 4639.1616, 48.6372),
                vector3(2871.7822, 4636.5459, 48.7074),
                vector3(2872.9092, 4622.3071, 48.7116),
                vector3(2887.6401, 4624.7578, 48.7442),
            },
            radius = 8.0,
            object = { model = 'prop_weed_02', respawnTime = 10000, },
            options = {
                {
                    label = 'Harvest',
                    icon = 'fa-solid fa-leaf',
                    minigame = true,
                    duration = 3000,
                    animation = {
                        dict = 'amb@world_human_gardener_plant@female@base',
                        clip = 'base_female',
                        prop = {
                            model = 'prop_cs_trowel',
                            pos = vector3(0.03, 0.03, 0.02),
                            rot = vector3(0.0, 0.0, -1.5),
                            bone = 28422,
                        },
                    },
                    onCompleted = {
                        giveItems = 'sativa_leaf',
                        exp = 20,
                    },
                },
            },
        },
        [2] = {
            label = 'Processing',
            blip = { active = true, color = 5, sprite = 469 },
            zones = {
                vector3(1905.5717, 4914.5806, 47.85),
            },
            object = { model = 'bkr_prop_weed_table_01a', rotation = 247.2577 },
            options = { {
                label = 'Process Sativa',
                icon = 'fa-solid fa-leaf',
                minigame = true,
                duration = 3000,
                cooldown = 5000,
                animation = {
                    dict = 'mp_fbi_heist',
                    clip = 'loop',
                },
                canInteract = { items = 'sativa_leaf' },
                onCompleted = {
                    removeItems = { ['sativa_leaf'] = 2 },
                    giveItems = { ['sativa_pure'] = 3 },
                    exp = 20,
                },
            }, },
        },
        [3] = {
            label = 'Rolling',
            options = { {
                duration = 7500,
                animation = {
                    scenario = 'PROP_HUMAN_PARKING_METER',
                },
                canInteract = {
                    items = {
                        ['sativa_pure'] = 1,
                        ['rolling_paper'] = 1,
                    },
                },
                onCompleted = {
                    removeItems = { 'sativa_pure', 'rolling_paper' },
                    giveItems = 'sativa_rolled',
                    exp = 30,
                },
            } },
            useableItem = 'sativa_pure',
            onItemUsed = { simulateOption = 1, }
        },
        [4] = {
            label = 'Packaging',
            blip = { active = true, color = 5, sprite = 469 },
            zones = {
                vector3(1545.8186, 6335.7173, 23.1),
            },
            object = { model = 'bkr_prop_weed_table_01a', rotation = 275.0 },
            options = { {
                label = 'Sativa Packaging',
                icon = 'fa-solid fa-cube',
                duration = 3000,
                cooldown = 5000,
                animation = { dict = 'mp_fbi_heist', clip = 'loop', },
                canInteract = { items = { ['sativa_rolled'] = 5 } },
                onCompleted = {
                    removeItems = { ['sativa_rolled'] = 5 },
                    giveItems = 'sativa_packed',
                    exp = 50,
                },
            }, },
        },
        [5] = {
            label = 'Usage',
            useableItem = 'sativa_rolled',
            onItemUsed = {
                simulateOption = 1,
                event = 'wasd-mixweed:weed:useRolledWeed',
            },
            options = { {
                duration = 5000,
                animation = {
                    scenario = 'WORLD_HUMAN_SMOKING_POT',
                },
                canInteract = { items = 'sativa_rolled' },
                onCompleted = { removeItems = 'sativa_rolled' },
            } }
        },
    },
},

#2

[2] = {
    label = 'Processing',
    blip = { active = true, color = 5, sprite = 469 },
    zones = {
        vector3(1905.5717, 4914.5806, 47.85),
    },
    object = { model = 'bkr_prop_weed_table_01a', rotation = 247.2577 },
    options = { 
        {
            label = 'Process Sativa',
            icon = 'fa-solid fa-leaf',
            minigame = true,
            duration = 3000,
            cooldown = 5000,
            animation = {
                dict = 'mp_fbi_heist',
                clip = 'loop',
            },
            canInteract = { items = 'sativa_leaf' },
            onCompleted = {
                removeItems = { ['sativa_leaf'] = 2 },
                giveItems = { ['sativa_pure'] = 3 },
                exp = 20,
            },
        }, 
    },
},

#3

[3] = {
    label = 'Rolling',
    options = { 
        {
            duration = 7500,
            animation = {
                scenario = 'PROP_HUMAN_PARKING_METER',
            },
            canInteract = {
                items = {
                    ['sativa_pure'] = 1,
                    ['rolling_paper'] = 1,
                },
            },
            onCompleted = {
                removeItems = { 'sativa_pure', 'rolling_paper' },
                giveItems = 'sativa_rolled',
                exp = 30,
            },
        },
    },
    useableItem = 'sativa_pure',
    onItemUsed = { simulateOption = 1, }
},

#4

[4] = {
    label = 'Packaging',
    blip = { active = true, color = 5, sprite = 469 },
    zones = {
        vector3(1545.8186, 6335.7173, 23.1),
    },
    object = { model = 'bkr_prop_weed_table_01a', rotation = 275.0 },
    options = { 
        {
            label = 'Sativa Packaging',
            icon = 'fa-solid fa-cube',
            duration = 3000,
            cooldown = 5000,
            animation = { dict = 'mp_fbi_heist', clip = 'loop', },
            canInteract = { items = { ['sativa_rolled'] = 5 } },
            onCompleted = {
                removeItems = { ['sativa_rolled'] = 5 },
                giveItems = 'sativa_packed',
                exp = 50,
            },
        },
     },
},

#5

[5] = {
    label = 'Usage',
    useableItem = 'sativa_rolled',
    onItemUsed = {
        simulateOption = 1,
        event = 'wasd-mixweed:weed:useRolledWeed',
    },
    options = { 
        {
            duration = 5000,
            animation = {
                scenario = 'WORLD_HUMAN_SMOKING_POT',
            },
            canInteract = { items = 'sativa_rolled' },
            onCompleted = { removeItems = 'sativa_rolled' },
        },
    },
},