Resource Configuration

This page provides comprehensive information about our configuration files, assisting in the setup of the resource.

---

cfg.z_interactions

This boolean value allows you to disable the default built-in interaction system for the script, enabling you to implement your own system.

---@field z_interactions boolean
---@description: Set as false if you do not want to use the interaction system build into z_hose
cfg.z_interactions = true

---

cfg.vehicles

This table contains the string values of the vehicle spawn codes you wish to configure with the resource. Once you have entered the string into this table, you will be able to create a new configuration module for the vehicle. This process is explained here.

---@field vehicles table
cfg.vehicles = {
    'firetruk',
    'fireengine'
}

Your configured vehicle requires a configuration module to function.

---

cfg.hoses

This table enables the configuration of hose weapons and associated objects. The hose weapons refer to the weapon hash used for spawning, while the objects correspond to the prop names of the weapons when the hose is positioned on the ground. You have the ability to edit both water and foam hoses.

---@field hoses table
cfg.hoses = {
    ['foam'] = {
        weapon = `WEAPON_FOAMBRANCH`,
        object = `w_me_foambranch`
    },
    ['water'] = {
        weapon = `WEAPON_REELBRANCH`,
        object = `w_me_reelbranch`
    }
}

---

cfg.objects

This table enables the modification of the objects utilized by the resource, allowing you to incorporate your own objects within z_hose.

---@field objects table
cfg.objects = {
    ['light_portable_pump'] = `prop_generator_01a`
}

Please ensure that the object name you enter is surrounded by backticks rather than regular quotation marks.

---

cfg.supplyMethods

This table facilitates the configuration of water supply methods. It contains numerous subtables, with the names of these tables indicating the objects to which the hose can be attached. Within each subtable, you will find editable values that allow you to customize the supply method accordingly.

Type

This string value enables the selection of the supply method type. You can choose between Hydrant and Suction; please note that the Suction option will necessitate the prop being placed within water.

Offset

This table value specifies the object offset to which the rope should be attached.

Flow Rate

This table allows for the editing of the flow rate of water to the vehicle, It allows for the decrease or increase of the amount of water that flows to the vehicle every tick, Each tick can be edited by editing the milliseconds value

---@field supplyMethods table
cfg.supplyMethods = {
    [`prop_fire_hydrant_1`] = {
        type = 'hydrant', -- | 'Hydrant' | 'Suction' |
        offset = vector3(0.3, 0.0, 0.6),
        flowRate = {
            increment = 5.0, ---| amount incremented per tick
            miliseconds = 100  ---| time in milliseconds for each tick
        }
    },

    [`prop_fire_hydrant_2`] = {
        type = 'Hydrant', -- | 'Hydrant' | 'Suction' |
        offset = vector3(0.2, 0.0, 0.7),
        flowRate = {
            increment = 5.0, ---| amount incremented per tick
            miliseconds = 100  ---| time in milliseconds for each tick
        }
    },

    [`prop_fire_hydrant_4`] = {
        type = 'Hydrant', -- | 'Hydrant' | 'Suction' |
        offset = vector3(0.15, 0.0, 0.62),
        flowRate = {
            increment = 5.0, ---| amount incremented per tick
            miliseconds = 100,  ---| time in milliseconds for each tick
        }
    },

    [cfg.objects['light_portable_pump']] = {
        type = 'Suction', -- | 'Hydrant' | 'Suction' |
        offset = vector3(0.0, 0.0, 0.4),
        flowRate = {
            increment = 5.0, ---| amount incremented per tick
            miliseconds = 100,  ---| time in milliseconds for each tick
        }
    },
}

---

cfg.decals

This table enables the customization of both water and foam world decals, which are generated during the application of water or foam.

Decal Type

This is the type of decal that has been created. You can find all the available decals here.

Decal Colour

This is the color of the decal represented in RGBA format, where A indicates the opacity of the decal.

Can Cover Entities

This boolean value enables the selection of whether this type of decal can cover objects, vehicles, and other entities.

---@field decals table
cfg.decals = {
    ['water'] = {
        decalType = 9010,
        decalColour = {R = 45, G = 45, B = 45, A = 0.5},
        canCoverEntities = false
    },
    ['foam'] = {
        decalType = 1050,
        decalColour = {R = 255, G = 255, B = 255, A = 0.7},
        canCoverEntities = true
    }
}

---

cfg.keybinds

This table facilitates the editing of the keybinds utilized by the resource. These keybinds are represented in string format and can be found in the following location: core > client > classes > keybinds.lua.

---@field keybinds table
---@description: Allow for the customization of keybinds utilized by the resource.
---@comment: https://docs.fivem.net/docs/game-references/controls/
---@comment: core > client > classes > keybinds.lua
cfg.keybinds = {
    -- % View Pump % --
    ['view_pump'] = 'Z',
    -- % Hose Reel % --
    ['use_reel'] = 'E',
    ['return_reel'] = 'E',
    -- % Supply Line % --
    ['connect_supply'] = 'G',
    ['disconnect_supply'] = 'G',
    -- % Relay Line % --
    ['connect_relay'] = 'G',
    ['disconnect_relay'] = 'G',
    -- % Pick Ups % --
    ['pickup_hosebranch'] = 'E',
    -- % Drop Hose % --
    ['drop_hosebranch'] = 'G',
    -- % Cancel Hose % --
    ['cancel_hose'] = 'X',
    -- % Drop Light Portable Pump % --
    ['drop_lpp'] = 'G',
}

---

cfg.languages

This table allows for the customization of both the language used by the resource and the associated strings. You can configure your preferred language within the fxmanifest.lua file.

---@field languages table
---@description: Allow for different languages to be utalised for displayed text.
cfg.languages = {
    ['en'] = {
        ['interactions'] = {
            -- % Hose Reel % --
            use_hosebranch = 'Take hose line',
            use_foambranch = 'Take foam line',
            return_reel = 'Return line',
            -- % Supply Line % --
            connect_supply = 'Take supply line',
            disconnect_supply = 'Disconnect supply line',
            connect_to = 'Connect to %s',
            -- % Relay Line % --
            connect_relay = 'Take relay line',
            disconnect_relay = 'Disconnect relay line',
            -- % Pick Ups % --
            pickup_hosebranch = 'Pick up hose branch',
            pickup_foambranch = 'Pick up foam branch',
            -- % Pump Panel % --
            view_pump = 'View pump panel',
        },

        ['notifications'] = {
            -- % Titles % --
            error = 'Error!',
            success = 'Success!',
            -- % Error Messages % --
            already_has_hose = 'User already possesses an active hose. Current hose ID: %s',
            no_hose_found = 'No active hose found for user. Current hose ID: %s',
            -- % Success Messages % --
            retrieved_branch = 'Retrieved %s branch!',
            returned_branch = 'Returned hose branch!',

            retrieved_supply = 'Retrieved supply line!',
            connect_to_supply = 'Connected to supply line!',
            disconnected_supply = 'Disconnected supply line!',

            retrieved_relay = 'Retrieved relay line!',
            connect_relay = 'Connected relay line!',
            disconnected_relay = 'Disconnected relay line!',

            cancelled_hose = 'Hose length cancelled!',

            lack_permission = 'You lack the permission for this action!'
        },

        ['contexts'] = {
            cancel_hose = 'Cancel hose',
            drop_hosebranch = 'Drop hose',
            drop_lpp = 'Drop LPP',
        }
    }
}

---