Fire functions

Author: FileEX

assets/Fire.png

@@ -1,4 +1,28 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/createFire
 client:
   name: createFire
-  description: THIS FUNCTION NEEDS DOCUMENTATION
+  description: Creates a patch of fire that will spread a bit and die out after a while. Because it's a client side only function, other players won't see it, so custom events or custom objects will be needed to make a fire visible to some players.
+  parameters:
+    - name: x
+      type: float
+      description: The X coordinate when the initial patch of fire will be created.
+    - name: y
+      type: float
+      description: The Y coordinate when the initial patch of fire will be created.
+    - name: z
+      type: float
+      description: The Z coordinate when the initial patch of fire will be created.
+    - name: size
+      type: float
+      description: A float value indicating the size of the initial patch of fire, this value also affects the duration of how long the fire remains.
+      default: '1.8'
+  returns:
+    values:
+      - type: bool
+        name: result
+    description: Returns true if successful, false if bad arguments were passed or the limit of active fires was reached. There can be a maximum of 60 active fires.
+  examples:
+    - path: 'examples/createFire-1.lua'
+      description: This example adds a `/fire` command, which creates a patch of fire in the position of the player that types it.
+  preview_images:
+    - path: '/assets/fire.png'
+      description: Fire with default size (1.8)

functions/Fire/createFire.yaml

@@ -0,0 +1,10 @@
+local function burn(commandName, theSize)
+   if tonumber(theSize) then
+        local x, y, z = getElementPosition(getLocalPlayer())
+        createFire(x, y, z, tonumber(theSize))
+        outputChatBox("Burn, buuuuurn >:]")
+   else
+        outputChatBox("Syntax: /fire <size>")
+   end
+end
+addCommandHandler("fire", burn)

functions/Fire/examples/createFire-1.lua

@@ -0,0 +1,7 @@
+local start = {0, 0, 4}
+
+for i = 1, 10 do
+    createFire(start[1] + i, start[2], start[3])
+end
+
+extinguishFire(start[1], start[2], start[3], 10)

functions/Fire/examples/extinguishFire-1.lua

@@ -1,4 +1,28 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/extinguishFire
 client:
   name: extinguishFire
-  description: THIS FUNCTION NEEDS DOCUMENTATION
+  description: This function is used to extinguish all spreading fire, or spreading fire at specified coordinates.
+  parameters:
+    - name: x
+      type: float
+      description: The X coordinate at which any fire will be extinguished.
+      default: 'nil'
+    - name: y
+      type: float
+      description: The Y coordinate at which any fire will be extinguished.
+      default: 'nil'
+    - name: z
+      type: float
+      description: The Z coordinate at which any fire will be extinguished.
+      default: 'nil'
+    - name: radius
+      type: float
+      description: A float value indicating the radius in which to extinguish fire.
+      default: '1.0'
+  returns:
+    values:
+      - type: bool
+        name: result
+    description: Always returns true.
+  examples:
+    - path: 'examples/extinguishFire-1.lua'
+      description: This example creates 10 fires and then instantly extinguishes them.