setElementOnFire

Client-side

Server-side

Shared

This page is incomplete! Help wanted!

Please finish this page using the corresponding Old Wiki article.
Go to Contribution guidelines for more information.

This function can be used to set a element on fire or extinguish a fire on it. Supported types are ped, vehicle and object.

Note

Function on the client side only works on elements created on the client side.

Syntax

 setElementOnFire ( )

Code Examples

server

Example 1:This example defines a command handler for the commandfireelement. This will fire up a player or their vehicle if the state is true. Otherwise the fire will be gone.

local stringToBoolean = {
    ["true"] = true,
    ["false"] = false
}

addCommandHandler("fireelement",
    function(sourcePlayer, commandName, fireState)
        -- if the player didn't complete the command.
        if not (fireState) then
            local text = string.format("[Usage]: #FFFFFF/%s [%s]", commandName, "State")

            return outputChatBox(text, sourcePlayer, 255, 100, 100, true)
        end

        -- the state will automatically be a string so we change it to boolean.
        local fireState = stringToBoolean[fireState]

        -- if the state isn't boolean then we return it.
        if type(fireState) ~= "boolean" then
            return outputChatBox("[Error]: #FFFFFFThe state has to be true or false.", sourcePlayer, 255, 100, 100, true)
        end

        local playerVehicle = getPedOccupiedVehicle(sourcePlayer)

        if playerVehicle then -- if the player is in a vehicle
            setElementOnFire(playerVehicle, fireState)
        else -- if the player is not in a vehicle
            setElementOnFire(sourcePlayer, fireState)
        end
    end, false, false
)

setElementOnFire

Syntax

Code Examples

See Also

Element Functions

Element Events

Reference