GetLatentEventStatus

From Multi Theft Auto: Wiki
Revision as of 10:30, 29 January 2012 by Ccw (talk | contribs) (Created page with "__NOTOC__ {{Server client function}} Gets the status of one queued latent event. ==Syntax== Server: <syntaxhighlight lang="lua"> table getLatentEventStatus( element player, int handle ) </syntaxhighlight> ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Gets the status of one queued latent event.

Syntax

Server:

table getLatentEventStatus( element player, int handle )

Client:

table getLatentEventStatus( int handle )

Required Arguments

  • player: (Only required if called on the server) The player who is receiving the event.
  • int : A handle previous got from getLatentEventHandles.

Returns

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

  • tickStart: A number representing how many ticks until the data transfer starts (Negative means the transfer has already started)
  • tickEnd: A number representing 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

See Also