Documentation

Config

functions.lua

functions.lua
return {
  ---Grabs the fuel level of the current vehicle.
  ---@param entVehicleId number
  ---@return number
  getFuel = function(entVehicleId)
    assert(entVehicleId, "[getFuel] invalid arg passed.")
    -- Logic Here.
    return 75
  end
}

shared.lua

shared.lua
return {
	language = "en",             -- You have to setup your own locale in `locales/**` and make sure the file name matches this string,
	framework = "none",          -- esx, qb, qbox, ox, nd, custom, none
	disableAutoDetection = false, -- Set to true if you wanna disable the auto framework & fuel resource detection.
	displayMinimapOnFoot = false, -- This could also be an option in the settings panel, although i'm unsure if people would want that since some servers want it forced off.
	hiddenUIComponents = {
		3,                       -- Cash
		6,                       -- Vehicle Name
		7,                       -- Area Name
		8,                       -- Vehicle Class
		9                        -- Street Name
	},
	useMapCustomZoomLevels = false, -- Enable if you wanna use your own custom zoom levels, the ones defined  in `mapZoomLevels`
	mapZoomLevels = {
		{
			index = 1,
			zoomScale = 2.7999999523163,
			zoomSpeed = 0.89999997615814,
			scrollSpeed = 0.079999998211861,
			tilesX = 0.0,
			tilesY = 0.0
		},
		{
			index = 2,
			zoomScale = 8.0,
			zoomSpeed = 0.89999997615814,
			scrollSpeed = 0.079999998211861,
			tilesX = 0.0,
			tilesY = 0.0
		},
		{
			index = 3,
			zoomScale = 11.0,
			zoomSpeed = 0.89999997615814,
			scrollSpeed = 0.079999998211861,
			tilesX = 0.0,
			tilesY = 0.0
		},
		{
			index = 4,
			zoomScale = 16.0,
			zoomSpeed = 0.89999997615814,
			scrollSpeed = 0.079999998211861,
			tilesX = 0.0,
			tilesY = 0.0
		},
		{
			index = 5,
			zoomScale = 55.0,
			zoomSpeed = 0.0,
			scrollSpeed = 0.10000000149012,
			tilesX = 2.0,
			tilesY = 1.0
		},
	},
	seatbeltEjectionValues = {
		ejectVelocity = (1 / 2.236936),
		unknownEjectVelocity = (2 / 2.236936),
		unknownModifier = 17.0,
		minDamage = 0.0,
	}
}

On this page