Configuring the resource

This document will show you how to configure the Bomb Disposal Robot.

To begin configuring Bomb Disposal Robot, open the config.lua file. This document will not discuss permissions, items or notifications and will be shown in the next document.

main = {
    spawnOffSet = {0.0, 4.0, 0.0},
    cameraPosition = {-0.1, -0.1, 1.0},
    cameraRotation = {-25.0, 0.0, 0.0},

    maximumDistance = 200.0,

    enableNightVision = true,
    enableThermalVision = true,

    explosionType = 4,
    explosionSize = 4.0,
    explosionCameraShake = 6.0,
}

The spawnOffSet value is the position relative to you at which the Bomb Disposal Robot will spawn when the command/item is used. By default, this is 4.0 metres in front of you.

The cameraPosition and cameraRotation values are relative to the Bomb Disposal Robot, which provides the position at which we will spawn the camera for the live stream.

The enableNightVision and enableThermalVision values determine whether players will be able to activate night vision and thermal imaging when controlling the Bomb Disposal Robot.

The explosionType is the type of explosion that will be used for the controlled explosion, from the list here.

The explosionSize is the size of the explosion that will be used for the controlled explosion, along with the explosionCameraShake which sets the scale of the effect that will be imposed on surrounding players.

EOD Command

This section will show you how to enable the EOD command. Permissions will be discussed in the next document.

eodCommand = {
    commandName = "eod",
    commandEnabled = true,

This section allows you to disable/enable the EOD command and also set the command name.

Wasabi Locking System Integration

lockingSystems = {
    wasabiCarlock = {
        enabled = false,
        resourceName = "wasabi_carlock",
    }
}

We've added support for Wasabi Locking system. If you want to integrate your own locking system, head to the cl_utils.lua file and add the relevant code into the following function:

-- Used to integrate vehicle locking resources
-- Listen for created EOD vehicles
function eodCreated(vehicleHandle)

end

This function is triggered whenever an EOD vehicle is created, with the vehicleHandle passed as an argument. This will allow you to trigger an export/event and register/unlock the vehicle with a third party vehicle locking resource.

Editing Controls

controls = {
    controlKey = {0, 19}, -- https://docs.fivem.net/docs/game-references/controls/ -- default Left ALT
    nightVisionKey = {0, 212},   
    thermalImagingKey = {0, 214},
    explosion = {0, 208},
    cancelExplosion = {0, 207},
    toggleWater = {0, 45},
    attachProp = 44,
    rotatingArmRight = 124,
    rotatingArmLeft = 123,
    rotatingArmBack = 0,
    rotatingArmForwards = 47,
    rotatingTopArmBack = 110,
    rotatingTopArmForwards = 111,
    rotatingTopArmUp = 117,
    rotatingTopArmDown = 118,
    rotateGrabberRight = 189,
    rotateGrabberLeft = 190,
    closeGrabber = 172,
    openGrabber = 173,
}

The controls section of the config allows you to edit the various controls. For a list of controls, see here.

Spawn Package Command

The /spawnpackage command allows players to spawn an item from a list of pre-configured items in-game. By default, we have configured 5 different props - bomb, bag, package, briefcase, suitcase.

SpawnPackageCommand = {
    Enabled = true,
    CommandName = "spawnpackage",
    CommandHelp = "Spawn a package for the EOD robot.",
    
    PackageTypes = {
        ["bomb"] = {
            model = `prop_bomb_01_s`,
        },
        ["bag"] = {
            model = `prop_cs_heist_bag_01`,
        },
        ["package"] = {
            model = `prop_mp_drug_package`,
        },
        ["briefcase"] = {
            model = `prop_ld_case_01`,
        },
        ["suitcase"] = {
            model = `prop_ld_suitcase_02`,
        },
    },

This command is enabled by default, however this section allows you to disable it.

The PackageTypes section allows you to add additional items or remove them. The ["name"] is in square brackets followed by the model within the curly brackets.

The model name must be in backticks to allow runtime hashing: ``

Translations

    setup = "setup",
    remove = "remove",
    invalidArgument = "Use /eod [setup/remove]",
    noPackageType = "You must select a package type",
    noItem = "You must have the EOD item",
    noPermission = "You lack the required permission",
    commandHelp = "Setup or remove an EOD robot.",
    bombVehicleName = "Bomb Robot",
    argumentHelp = "setup/remove",
    noneFound = "No EOD found to remove",
    inVehicle = "You must not be in a vehicle",
    tooFar = "EOD removed as you have moved too far away",
    loosingConnection = "You are loosing connection to the EOD",
    eodSetup = "~r~Info~w~: EOD Setup",
    eodRemoved = "~r~Info~w~: EOD Removed",
    cancelExplosion = "Press ~INPUT_FRONTEND_LT~ to cancel.",
    explosionCancelled = "Explosion Cancelled",
    explosionStarted = "Explosion Started - Leave The Area",
    packageType = "Package Type",
    spawnPackage = "Spawn a Package",
}

This section allows you to translate the resource into another language.