How To Use
Discoverable Blips
They are locations you can discover, when you enter them it will show a popup of the name of the location and then continue to show a marker on the map. To make use of these you must first enable it in the config.lua and you can customise how they are displayed here too.
DiscoveryBlips = {
enable = true, -- Set to false to disable the onDutyBlip system
displayTime = 6000, -- time in ms to display the notification
fadeInSpeed = 15, -- speed of fade in
fadeOutSpeed = 2, -- speed of fade out
showPopupBackground = true, -- Adds the black background to the popup
-- Could possibly be seen as "too much" so made it optional
alwaysShowLocationName = true, -- if enabled, will always show the location name on entering the area
},
Example of a FiveM Discoverable Location:
["example_fivem1"] = { -- Name needs to be unique
coords = vec3(-206.07, -1321.77, 30.89), -- The center coords of the zone that is discoverable
name = "Benny's Original Motor Works", -- Name of the location (and the blip's name)
description = "Fix and upgrade your vehicle here.", -- This is optional, adds a bit of flare to the popup
sprite = 72, -- The blip sprite ID
color = 47, -- The blip colour ID
discoverRadius = 30.0 -- The max distance of the created zone
},
Example of a RedM Discoverable Location:
["example_redm1"] = { -- Name needs to be unique
coords = vec3(1193.48, -1218.85, 74.32), -- The center coords of the zone that is discoverable
name = "Benny's Original Motor Works", -- Name of the location (and the blip's name)
description = "Fix and upgrade your vehicle here.", -- This is optional, adds a bit of flare to the popup
sprite = `blip_ambient_death`, -- Blip Hash
discoverRadius = 30.0 -- The max distance of the created zone
},
onDutyBlips
These blips change status based on wether players with a certain job role are on Duty or not, marking the location as "open"
This comes with options to always show the blip or only when they are onDuty, if they are off duty it will show a blip but marked it as "Closed" This requires it to be enabled in the config
onDutyBlips = {
enable = false, -- Set to false to disable the onDutyBlip system
alwaysShowblips = false, -- If true, the blips for the locations will always show, but not show "open"
-- Not recommended if you have alot of onDuty blips as the max total blips is 99
},
Example
burgershot = { -- Server Job Role
label = "BurgerShot", -- Blip Name/Label
coords = vec3(-1186.11, -885.86, 13.97), -- Where the coord should appear
col = 5, -- Blip Colour ID
sprite = 106, -- Blip Sprite ID
scale = 0.7, -- Blip Scale
disp = 6, -- Blip Display
preview = "https://i.fmfile.com/eFySKfWwZGMDm0btrLE8o/FiveM_GTAProcess_0h8ObU9Jkn.jpg" -- Map preview image
},
Player Blips
This is experimental but works
This allows players to see either other on the map, if they have the specified job roles
This requires enabling in the config
playerBlips = {
enable = false,
},
Example
ambulance = { -- The job role that we are allowing to see other players
color = 41, -- The blip colour of the job role
allowedJobs = { -- The table of other jobs the player can see
police = true, -- This will allow `ambulance` role to see `police` players on the map
ambulance = true, -- Putting this in allows the `ambulance` to see `ambulance` aswell
}
},
Last updated