CancelLatentEvent

Stops a latent event from completing

Syntax

Click to collapse [-]

Server

bool cancelLatentEvent( player thePlayer, int handle )

Required Arguments

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

Click to collapse [-]

Client

bool cancelLatentEvent( int handle )

Required Arguments

• handle: A handle previous got from getLatentEventHandles.

Returns

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

Example

Click to collapse [-]

Example 1 - 1/2

-- 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)

Click to collapse [-]

Example 1 - 2/2

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

Click to collapse [-]

Example 2

-- 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)

Click to collapse [-]

Example 3

-- 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)

Requirements

Minimum server version	1.3.0-9.03772
Minimum client version	1.3.0-9.03772

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.3.0-9.03772" client="1.3.0-9.03772" />

See Also

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