Manual Review Required

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

---

Stops a latent event from completing

Syntax

bool cancelLatentEvent ( int handle )

Required Arguments

• handle: A handle previous got from getLatentEventHandles .

Returns

• bool: value

Returns a true if the latent event was successfully cancelled, or false if it was not

Code Examples

Example 1 Example 2 Example 3 Example 4

client

-- Cancel triggerLatentServerEvent directly after execution.
addCommandHandler("cancelLatentEvent",
function ()
  triggerLatentServerEvent("exampleEvent",3000,false,localPlayer)

  -- Get all your active handles, when you executed the command: /cancelLatentEvent
  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)

client

-- Cancel all my triggerLatentServerEvent's.
addCommandHandler("cancelLatentEvents",
function ()

  -- Get all your active handles, when you executed the command: /cancelLatentEvents
  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

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

server

-- Cancel all my triggerLatentClientEvent's.
addCommandHandler("cancelLatentEvents",
function (player)

  -- Get all active handles from the player that executed the command: /cancelLatentEvents
  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