This page provides comprehensive information about our configuration files, assisting in the setup of the resource.
cfg.updateDist
This numerical value allows for customization of the distance traveled before the rope/hose updates its position. Please note that a higher value will result in a greater stretch of the hose, but it may appear less visually realistic.
---@section updateDist
---@description: Enable customization of the distance traveled before the rope updates its position.
cfg.updateDist = 1.5
cfg.syncInterval
This integer value is measured in seconds and controls the interval at which rope synchronization occurs between clients. A lower value results in faster synchronization and improved visual quality; however, this may negatively impact performance. Conversely, increasing the value can enhance performance but may lead to slower synchronization and a less appealing visual experience.
---@section syncInterval
---@description: This is the interval during which the hose synchronization occurs between clients.
cfg.syncInterval = 1
cfg.interactions
This table facilitates the integration of customized targeting and interaction systems. You can select a method represented by a string; the default method is z_interactions. Additionally, ox_target is included by default but must be selected to be operational.
---@section interactions
cfg.interactions = {
method = 'z_interactions', ---|> | 'z_interactions' | 'ox_target' |
distance = 0.2 ---|> Distance which users can view and interact.
}
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.
---@section hoses
cfg.hoses = {
['foam'] = {
weapon = `WEAPON_FOAMBRANCH`,
object = `w_me_foambranch`,
attachment= { ---|> Offset where the rope attaches to the weapon
offset = vector3(-0.15, 0.0, -0.01)
},
particles = { ---|> Position and Rotation of particles emitted
offset = vector3(0.57, 0.05, -0.35),
rotation = vector3(15.0, 0.0, -90.0)
}
},
['water'] = {
weapon = `WEAPON_REELBRANCH`,
object = `w_me_reelbranch`,
attachment= { ---|> Offset where the rope attaches to the weapon
offset = vector3(-0.2, 0.0, 0.01)
},
particles = { ---|> Position and Rotation of particles emitted
offset = vector3(0.1, 0.0, 0.015),
rotation = vector3(0.0, 0.0, -90.0)
}
}
}
cfg.objects
This table enables the modification of the objects utilized by the resource, allowing you to incorporate your own objects within z_hose.
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
---@section supplyMethods
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['standpipe']] = {
type = 'Hydrant', ---|> | 'Hydrant' | 'Suction' |
offset = vector3(0.08, 0.07, 0.72),
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
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.
---@section decals
cfg.decals = {
['water'] = {
decalType = 9004,
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 > enums.lua.
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.
---@section languages
---@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 % --
take_relay = 'Take relay line',
connect_relay = 'Connect 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',
-- % Connect Standpipe % --
connect_standpipe = 'Connect standpipe',
-- % Refill Foam % --
refill_foam = 'Fill foam tank'
},
['notifications'] = {
-- % Titles % --
error = 'Error!',
success = 'Success!',
info = 'Info!',
-- % Errors % --
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',
while_in_vehicle = 'Cannot complete this action while in a vehicle!',
while_not_in_vehicle = 'Cannot complete this action while not in a vehicle!',
vehicle_not_valid = 'Cannot complete this action while in a invalid vehicle!',
lack_permission = 'You lack the permission for this action!',
does_not_carry = 'This vehicle does not have a water tank!',
failed_to_collect = 'Failure to collect a hose, This is a server issue.!',
failed_to_find = 'Failure to collect a hose, Please ensure the vehicle is within your view!',
panel_in_use = 'The pump panel is currently in use. Please wait until it is available.',
-- % Branch % --
retrieved_branch = 'Retrieved %s branch!',
returned_branch = 'Returned hose branch!',
cancelled_hose = 'Hose length cancelled!',
-- % Supply % --
retrieved_supply = 'Retrieved supply line!',
connect_to_supply = 'Connected to supply line!',
disconnected_supply = 'Disconnected supply line!',
-- % Relay % --
retrieved_relay = 'Retrieved relay line!',
connect_relay = 'Connected relay line!',
disconnected_relay = 'Disconnected relay line!',
-- % Foam % --
foam_filled = 'Foam tank has been filled!',
foamcan_gained = 'Foam Cam gained, Head to the nearest vehicle to fill its foam tank!',
foamcan_cancelled = 'Foam Cam has been removed following the cancellation of the action.',
-- % Standpipe % --
standpipe_placed = 'Standpipe placed!',
standpipe_deleted = 'Standpipe deleted!',
-- % Light Portable Pump % --
lpp_placed = 'Light Portable Pump placed!',
lpp_deleted = 'Light Portable Pump deleted!',
lpp_no_water = 'Water not detected. Ensure the water is deep enough!',
},
['contexts'] = {
cancel_action = 'Cancel',
cancel_hose = 'Cancel hose',
drop_hosebranch = 'Drop hose',
drop_lpp = 'Drop LPP',
}
}
}
