createFire

Client-side

Server-side

Shared

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.

Syntax

bool createFire ( float x, float y, float z, [ float size = 1.8 ] )

Required Arguments

x: The X coordinate when the initial patch of fire will be created.
y: The Y coordinate when the initial patch of fire will be created.
z: The Z coordinate when the initial patch of fire will be created.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

size (default: 1.8): A float value indicating the size of the initial patch of fire, this value also affects the duration of how long the fire remains.

Returns

bool: result

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.

Code Examples

client

This example adds a /fire command, which creates a patch of fire in the position of the player that types it.

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)

Gallery

Click on the image to view the full preview along with the description.