Stops a latent event from completing.

Client Syntax

​bool cancelLatentEvent ( ​int handle )

Required Arguments

• handle: A handle previous got from getLatentEventHandles.

Returns

• bool: result

Returns a true if the latent event was successfully cancelled, otherwise false.

Server Syntax

​bool cancelLatentEvent ( ​player thePlayer, ​int handle )

Required Arguments

• thePlayer: The player who is receiving the event.
• handle: A handle previous got from getLatentEventHandles.

Returns

• bool: result

Returns a true if the latent event was successfully cancelled, otherwise false.

Code Examples

Example 1 Example 2 Example 3

client

-- *****************************************************************************
-- CLIENT CODE
addCommandHandler("cancelLatentEvent", function()
    triggerLatentServerEvent("exampleEvent", 3000, false, localPlayer)
    local handles = getLatentEventHandles() -- Returns a table.
    local handle = handles[#handles] -- Get the latest handle.

    if cancelLatentEvent(handle) then -- Cancel it!
        outputChatBox("Successfully cancelled!", 0, 200, 0)
    end
end)

-- *****************************************************************************
-- SERVER CODE
addEvent("exampleEvent", true)
addEventHandler("exampleEvent", root, function()
    outputChatBox("Warning! The triggerLatentServerEvent wasn't cancelled!", client, 255, 0, 0) -- warn the user.
end)

client

Cancel all my triggerLatentServerEvent's.

addCommandHandler("cancelLatentEvents", function()
    local handles = getLatentEventHandles() -- Returns a table.

    for index = 1, #handles do -- Loop through the table.
        local handle = handles[index]
        cancelLatentEvent(handle) -- Cancel it!
    end
end)

server

Cancel all my triggerLatentClientEvent's.

addCommandHandler("cancelLatentEvents", function(player)
    local handles = getLatentEventHandles(player) -- Returns a table.

    for index = 1, #handles do -- Loop through the table.
        local handle = handles[index]
        cancelLatentEvent(player, handle) -- Cancel it!
    end
end)

See Also

Event Functions

• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getCancelReason
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerClientEvent
• triggerEvent
• triggerLatentClientEvent
• triggerLatentServerEvent
• triggerServerEvent
• wasEventCancelled

Reference

• Scripting Functions