Developer Exports

This page serves to outline and explain the functions offered by Zea Developments' z_fire resource. These functions are designed for the purpose of collecting existing data or storing new data.

---

Client Exports

IsVehicleOnFire

This export will return a true or false value based on whether the entity provided has a fire attached to it.

boolean = exports['z_fire']:isVehicleOnFire(handle)

deleteFireById

This export function will delete the provided fire ID and return true. If the fire ID provided is invalid, the function will return false.

boolean = exports['z_fire']:deleteFireById(fireId)

deleteSmokeById

This export function will delete the provided smoke ID and return true. If the smoke ID provided is invalid, the function will return false.

boolean = exports['z_fire']:deleteSmokeById(smokeId)

getFiresInRange

This export function will retrieve all identified fires within the specified world position range. The detected fires will be added to the table. If no fires are detected, the table will remain empty.

table = exports['z_fire']:getFiresInRange(worldPos, range)

getSmokeInRange

This export function will retrieve all identified smoke within the specified world position range. The detected smoke will be added to the table. If no fires are detected, the table will remain empty.

table = exports['z_fire']:getSmokeInRange(worldPos, range)

getClosestFire

This export function is designed to locate the nearest fire based on the world position provided, and will output the fireId of the closest one identified.

fireId, fireData, distance = exports['z_fire']:getClosestFire(worldPos)

getClosestSmoke

This export function is designed to locate the nearest smoke based on the world position provided, and will output the smokeId of the closest one identified.

smokeId, smokeData, distance = exports['z_fire']:getClosestSmoke(worldPos)

Server Exports

isPlayerOnDuty

This export will return a boolean value indicating whether the source provided is registered as a book on duty or not.

boolean = exports['z_fire']:isPlayerOnDuty(source)

setPlayerDuty

This export will set the status of the source provided. If the status is true, the dept value must be filled with a registered departments abbreviation. If the status is not set to true, this value can be left as nil.

The export will result in either a boolean true value if the action was successful or a nil value if there was an error. Additionally, the export will provide an error code and error message.

isSuccess, errorCode, errorMessage = exports['z_fire']:setPlayerDuty(source, dept, status)

createFire

This export function will generate a fire based on the data provided. This function does not yield any output.

exports['z_fire']:createFire({       
   ptfxData = { type = string?, pos = vector3?, scale = float? },
   behaviourType = string?,
   canSpread = bool?,
   spreadSize = int?,
   networkEntity = int?,
   origin = {is = true, id = nil}
})

createSmoke

This export function will generate a smoke source based on the data provided. This function does not yield any output.

exports['z_fire']:createSmoke({       
  ptfxData = { type = string?, pos = vector3?, scale = float? },
  canDisperse = bool?,
  networkEntity = int?,
})

---