GetLatentEventStatus
From Multi Theft Auto: Wiki
Gets the status of one queued latent event.
Syntax
Click to collapse [-]
Servertable getLatentEventStatus( player thePlayer, int handle )
Required Arguments
- thePlayer: The player who is receiving the event.
- handle: A handle previous got from getLatentEventHandles.
Click to collapse [-]
Clienttable getLatentEventStatus( int handle )
Required Arguments
- handle: A handle previous got from getLatentEventHandles.
Returns
Returns a table with the following info or false if invalid arguments were passed:
- tickStart: A number estimating how many ticks until the data transfer starts (Negative means the transfer has already started)
- tickEnd: A number estimating how many ticks until the data transfer completes
- totalSize: A number representing how many bytes in total this transfer will transfer
- percentComplete: A number between 0-100 saying how much is done
Example
Click to collapse [-]
ClientThe 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
Requirements
| Minimum supported server | 1.3.0-9.03772 |
|---|---|
| Minimum supported client | 1.3.0-9.03772 |
Note: Using this function 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" />
