MrNewb
a7b3a34998
Replaced comment blocks with LuaDoc @description tags for GetResourceName, GetFuel, and SetFuel functions across all fuel module client files. This improves code documentation consistency and supports better tooling integration.
29 lines
887 B
Lua
29 lines
887 B
Lua
---@diagnostic disable: duplicate-set-field
|
|
Fuel = Fuel or {}
|
|
|
|
|
|
---@description Returns the name of the active fuel resource.
|
|
---@return string
|
|
Fuel.GetResourceName = function()
|
|
return 'default'
|
|
end
|
|
|
|
---@description Returns the current fuel level of a vehicle.
|
|
---@param vehicle number The vehicle entity handle.
|
|
---@return number The vehicle fuel level.
|
|
Fuel.GetFuel = function(vehicle)
|
|
if not DoesEntityExist(vehicle) then return 0.0 end
|
|
return GetVehicleFuelLevel(vehicle)
|
|
end
|
|
|
|
---@description Sets the fuel level of a vehicle.
|
|
---@param vehicle number The vehicle entity handle.
|
|
---@param fuel number The fuel level to assign.
|
|
---@param type? string The fuel type, used only in ti_fuel. (default: RON91)
|
|
---@return nil
|
|
Fuel.SetFuel = function(vehicle, fuel, type)
|
|
if not DoesEntityExist(vehicle) then return end
|
|
SetVehicleFuelLevel(vehicle, fuel)
|
|
end
|
|
|
|
return Fuel |