GetLatentEventStatus
Jump to navigation
Jump to search
Gets the status of one queued latent event.
Syntax
Server:
table getLatentEventStatus( player thePlayer, int handle )
Client:
table getLatentEventStatus( int handle )
Required Arguments
- thePlayer: (Only required if called on the server) The player who is receiving the event.
- 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
--TODO
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
Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled