📕User guide

User guide on how to use the Dynasty Mug & Carjack

1.Police needed

You can configure the ammount of police officers online to allow mugging and carjacking.

Config.CopsNeeded = 0

2.Cooldowns

You can configure the duration in seconds to complete the actions andd the cooldown period between robbing attempts.

Config.RobWaitTime = 5 -- Duration
Config.CoolDownTime = 3 -- Wait to rob again

2.Police interactions

You can configure the chance of police notificacion upon robbing, the delay in seconds before police are notified after robbing and if always notify police if an NPC dies during the action.

Config.PoliceNotify = 40 
Config.TimeToNotifyPolice = 5 
Config.AlwaysNotifyonDeath = true 

3.Voice interaction

You can configure if it is required for a player to use voice chat to initiate the action.

Config.MustUseVoice = true

4.Voice interaction

You can configure the keybind for initiating the action.

Config.MugKey = { key = 38, label = "E" }

5.Received objects

You can configure to enable black money trasnactions instead of regular cash and minimum and maximum cash reward. You can also configure the chance to receive additional items during the mugging, with maximum nomber of items receivable.

Config.AddItemsPercent = 90   
Config.AddItemsMax = 1        
Config.GiveableItems = {  
    'phone',
}

6.Progress bar

You can enable a progress bar for mugging and carjacking.

Config.Progressbar = false            --  Enables a progress bar for mugging if available on the server.
Config.ProgressbarExport = function()
    exports['progressbar']:Progress({ -- Configuration for the mugging progress bar.
        name = "unique_action_name",
        duration = Config.RobWaitTime * 1000,
        label = "Aiming with the gun...",
        useWhileDead = false,
        canCancel = true,
        controlDisables = {
            disableMovement = false,
            disableCarMovement = false,
            disableMouse = false,
            disableCombat = false,
        }
    }, function()
    end)
end
Config.ProgressBarCancelExport = function() -- Function to cancel the progress bar.
    exports['progressbar']:Cancel()
end

7.Dispatch

You can configure dispatch alerts for mugging and carjacking.

Config.Dispatch = true                                        -- Enables dispatch alert if available on the server.
Config.DispatchExport = function(coords, gender, streetLabel) -- Configuration for the dispatch alert.
    TriggerEvent('qb-policealerts:client:AddPoliceAlert', {
        timeOut = 5000,
        alertTitle = "Mug",
        coords = {
            x = coords.x,
            y = coords.y,
            z = coords.z,
        },
        details = {
            [1] = {
                icon = '<i class="fas fa-venus-mars"></i>',
                detail = gender,
            },
            [2] = {
                icon = '<i class="fas fa-globe-europe"></i>',
                detail = streetLabel,
            },
        },
    })
    PlaySound(-1, "Lose_1st", "GTAO_FM_Events_Soundset", 0, 0, 1)
    local transG = 250
    local blip = AddBlipForCoord(coords.x, coords.y, coords.z)
    SetBlipSprite(blip, 161)
    SetBlipColour(blip, 1)
    SetBlipDisplay(blip, 4)
    SetBlipAlpha(blip, transG)
    SetBlipScale(blip, 1.3)
    SetBlipAsShortRange(blip, false)
    BeginTextCommandSetBlipName('STRING')
    AddTextComponentString("Mugging alert")
    EndTextCommandSetBlipName(blip)
    while transG ~= 0 do
        Wait(180 * 4)
        transG = transG - 1
        SetBlipAlpha(blip, transG)
        if transG == 0 then
            SetBlipSprite(blip, 2)
            RemoveBlip(blip)
            return
        end
    end
end