Setting up weapons

Setting up weapon is a crucial part of the configuration file. This allows you to define which weapons the script will work with and then subsequently use them when configuring fire types, to decide how different fires respond to them.

This can be found in the weapons = { section.

We'll use the weapons.water as an example of configuring a weapon type. This is the weapon that is usable by doing /hose if you are using our HoseLS resource.

You can easily add or remove weapons and modify them by following the guide below.

water = {
        model = `weapon_hose`, -- If you are using HoseLS, we do not recommend changing this
        name = "Hose",
        reduceBy = 0.70, -- This is how powerful it is, lower the number the better
        increaseBy = 1.3, --  This is how powerful it is against the wrong fire type, higher the number the more powerful
},

Firstly, the name of the weapon must be defined, as seen here this is titled water, as this is what the Hose is used for.

The model is the model of the weapon, for HoseLS, our v2 includes an addon weapon with a model name of weapon_hose.

Important: All model names must be wrapped in the following symbol: ``. (This is different to '')

The name of the weapon is mainly used for logging purposes and enables you to know which weapon was used to extinguish a fire.

The reduceBy multiplier determimes how powerful the weapon is against fires, where it is specified in that fire type. A multiplier of 0.7 would reduce the fire size to 70% of its previous size every so often. How often this takes place is determined by the difficulty of each fire type configured.

The increaseBy multiplier determines how powerful the weapon is against fires where it is defined in the toIncrease section of that type, A multiplier of 1.3 would increase the fire size by 30% every so often. How often this takes place is also determined by the difficulty of each fire type configured.