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.
31 lines
1.0 KiB
Lua
31 lines
1.0 KiB
Lua
---@diagnostic disable: duplicate-set-field
|
|
local resourceName = "ox_fuel"
|
|
if GetResourceState(resourceName) == 'missing' then return end
|
|
Fuel = Fuel or {}
|
|
|
|
---@description Returns the name of the active fuel resource.
|
|
---@return string
|
|
Fuel.GetResourceName = function()
|
|
return resourceName
|
|
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 Entity(vehicle).state.fuel
|
|
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
|
|
local state = Entity(vehicle).state
|
|
state.fuel = (state.fuel or 0) + fuel
|
|
end
|
|
|
|
return Fuel |