getLatentEventStatus | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getLatentEventStatus

Client-side
Server-side
Shared

Gets the status of one queued latent event.

Client Syntax 

​table getLatentEventStatus ( ​int handle )
Required Arguments

Returns

  • table: result

Returns a table with the following info, otherwise false if invalid arguments were passed.

Server Syntax 

​table getLatentEventStatus ( ​player thePlayer, ​int handle )
Required Arguments
  • thePlayer: The player who is receiving the event.
  • handle: A handle previous got from getLatentEventHandles.

Returns

  • table: result

Returns a table with the following info, otherwise false if invalid arguments were passed.

Code Examples

client

The example starts a latent event and outputs the status of the transfer to the client console.

function beginTransfer()
    triggerLatentServerEvent("blah", resourceRoot, myVeryLongString) -- Start latent event
    myHandle = getLatentEventHandles()[#getLatentEventHandles()] -- Get last latent event handle
    myTimer = setTimer(updateStatus, 1000, 0) -- Output status once a second
end


function updateStatus()
    local status = getLatentEventStatus(myHandle) -- Get latent event status
    if not status then
        killTimer(myTimer) -- getLatentEventStatus returns false when the handle is no longer valid
    else
        outputConsole("Transfer status:" .. " tickStart:" ..
                          tostring(status.tickStart) .. " tickEnd:" ..
                          tostring(status.tickEnd) .. " totalSize:" ..
                          tostring(status.totalSize) .. " percentComplete:" ..
                          tostring(status.percentComplete))
    end
end

See Also

Event Functions
Reference