Client Exports

Get Water Level

This client-side export is designed to enable external access to the vehicle's water tank level. It returns a float value upon successful execution and provides a nil response along with an error message in string format if it fails.

Example usage

local waterLevel, errorMsg = exports['z_hose']:getWaterLevel(vehicleHandle)

if waterLevel ~= nil then
   print('waterLevel:', waterLevel)
else
   print('errorMsg:', errorMsg)
end

---

Get Foam Level

This client-side export is designed to enable external access to the vehicle's foam tank level. It returns a float value upon successful execution and provides a nil response along with an error message in string format if it fails.

Example Usage

local foamLevel, errorMsg = exports['z_hose']:getFoamLevel(vehicleHandle)

if foamLevel ~= nil then
   print('foamLevel:', foamLevel)
else
   print('errorMsg:', errorMsg)
end

---

Set Water Level

This client-side export is intended to facilitate external control of vehicle water tank levels. It will return a boolean value along with the updated water level if the execution is successful, and return nil along with a string error message in the event of a failure.

Example Usage

local isSuccess, newWaterLevel = exports['z_hose']:setWaterLevel(vehicleHandle, 100.0)

if IsSuccess then 
   print('newWaterLevel:', newWaterLevel)
else
   print('errorMsg:', errorMsg)
end

---

Set Foam Level

This client-side export is intended to facilitate external control of vehicle foam tank levels. It will return a boolean value along with the updated foam level if the execution is successful, and return nil along with a string error message in the event of a failure.

Example Usage

local IsSuccess, newFoamLevel = exports['z_hose']:setFoamLevel(vehicleHandle, 100.0)

if IsSuccess then 
   print('newFoamLevel:', newFoamLevel)
else
   print('errorMsg:', errorMsg)
end

---

Is Pump Engaged

This client-side export is intended to provide external access to the status of vehicle pumps. It will return a boolean value, either true or false, based on the pump's status. A return value of true indicates that the pump is engaged/enabled, while a return value of false signifies that it is disengaged/disabled. In the event of a function failure, it will return a nil value along with an error message string.

Example Usage

local IsEngaged, errorMsg = exports['z_hose']:isPumpEngaged(vehicleHandle)

if IsEngaged ~= nil then 
   print('IsEngaged:', tostring(IsEngaged))
else
   print('errorMsg:', errorMsg)
end)

---

Set Pump Status

This client-side export is designed to enable external monitoring of the vehicle's pump status. It will return true along with the updated status of the pump if the operation is successful, or it will return nil accompanied by an error message string if the export fails.

Example Usage

local IsSuccess, newStatus_errorMsg = exports['z_hose']:setPumpStatus(vehicleHandle, boolean)

if IsSuccess ~= nil then 
   print('newStatus_errorMsg:', tostring(newStatus_errorMsg))
else
   print('errorMsg:', newStatus_errorMsg)
end)

---

Has Supply

This client-side export is designed to provide external information regarding whether a vehicle has a connected supply. The export will return a boolean value indicating the presence of a supply, provided that the export is successful. If the export fails, it will return nil along with an error message.

Example Usage

local hasSupply, errorMsg = exports['z_hose']:hasSupply(vehicleHandle)

if hasSupply ~= nil then 
   print('hasSupply:', tostring(hasSupply))
else
   print('errorMsg:', errorMsg)
end)

---

Open Pump Panel

This client-side export is designed to facilitate greater integration. It will access the pump interface of the vehicle you are examining. Please note that this export will only return nil along with an error message string, indicating that an issue has occurred within the function.

Example Usage

local IsSuccess, errorMsg = exports['z_hose']:openPumpPanel()

---

Is Using Hose

This client-side export is designed to assist with integration into fire resources, this export will only return true when the hose is being sprayed and particles are emitting otherwise this export returns false.

Example Usage

local IsUsing = exports['z_hose']:IsUsingHose()

---

Return Hose

This client-side export is designed to assist with integration into fire resources, this export will only return true when the hose is being sprayed and particles are emitting otherwise this export returns false.

---

This page is not yet complete.