Misc configuration values

At the top of the config.lua file, you'll see some configuration values that just don't fit into another section, we describe them as misc configuration values.

We'll explain what these are for and then you'll be able to change them should you wish to do so.

Navigate to the top of the config.lua file and find the main = { section.

fireSpawnDistance = 200.0, -- This is the distance the player must be within to a fire to spawn in (for performance)
smokeSpawnDistance = 500.0,-- This is the distance the player must be within to smoke to spawn in (for performance)

These are the distances that both fires and smoke will spawn in at for performance. For example, if you are on the other side of the map to a fire, the script shouldn't spawn that in and would be a badly performing resource if it did so.

We recommend having the smoke spawn distance greater than the fire spawn distance, as smoke can often be seen further away as the firefighters or civilians approach a scene.

usingHoseLS = true,

This defines if you are using our HoseLS resource and wish to integrate it in with the resource. This will allow you to use the weapons.water in the weapons section later on and also when configuring fire types and their responsiveness to weapons.

distanceToSpawnFiresInFront = 2, -- Distance to spawn fires in front (to avoid player being damaged initially)

This controls the distance a fire will spawn in front of a player when using the /startfire command to prevent them being immediately damaged by the fire starting.

maxWidthOfFiresMultipler = 1.2, -- Max width of fires. E.g, a 15 flame fire would have a maximum width of 22.5m (rounded to nearest integer)
maximumFinalWidth = 20.0, -- This is the maximum width, incase the multiplier leads the maximum to be too big

We would recommend leaving these values as they are now, but ultimately they preventsfires becoming too big and out of hand if a large multi flame fire is created. This prevents the flames being too spread out. As seen in the explanation, a multiplier of 1.2 would have a 15 flame fire having a maximum width of 22.5m (rounded to the nearest whole number).

A maximum final width value prevents a fire becoming too big if a significant amount of flames (for example 30) leads to a width too unrealistic. This would limit the max width of the fire and compress the flames together.

These configuration value smay seem confusing, which is why we recommend leaving them as they are.

foam = {
        enabled = true,-- This will enable foam mode, allowing you to use /foam to spray foam through the 
        (particles are the same, but fires will respond differently)
        -- Foam mode can only be enabled if you are using Hose LS above
},

This determines if you wish to use the /foam integration with HoseLS. You must be using HoseLS for this to work.

Enabling this allows you to use the weapons.foam when setting up fire types and also configuring the weapons in a further section.

We recommend using HoseLS and also the foam mode if you want the most realistic experience.

minimumSizeToExtinguish = 0.5, -- This is the minimum size a fire can be whilst being put out before the script removes it completely

This value determines how small a fire can be when being actively extinguished before the script determines it to be fully out and will then subsequently remove it and spawn in smoke if configured to do so.

We have configured a default value of 0.5 however this may be too small for your server and you therefore may wish to increase it, especially if a fire is hidden inside an object such as a bin or vehicle where firefighters may not see such a small fire is still present.