GetLatentEventStatus - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T15:45:15Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:45, 7 November 2024
Line 54:		Line 54:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~==Requirements==~~
	~~{{Requirements\|1.3.0-9.03772\|1.3.0-9.03772\|}}~~

	==See Also==		==See Also==
	{{Event functions}}		{{Event functions}}

MTA SE: /* added sections for server/client syntax */

2012-07-04T06:02:31Z

added sections for server/client syntax

← Older revision		Revision as of 06:02, 4 July 2012
Line 4:		Line 4:

	==Syntax==		==Syntax==
	Server:
			<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getLatentEventStatus( player thePlayer, int handle )		table getLatentEventStatus( player thePlayer, int handle )
	</syntaxhighlight>		</syntaxhighlight>
	Client:		===Required Arguments===
			*'''thePlayer:''' The player who is receiving the event.
			*'''handle:''' A handle previous got from [[getLatentEventHandles]].
			</section>

			<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getLatentEventStatus( int handle )		table getLatentEventStatus( int handle )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''thePlayer:''' (Only required if called on the server) The player who is receiving the event.
	*'''handle:''' A handle previous got from [[getLatentEventHandles]].		*'''handle:''' A handle previous got from [[getLatentEventHandles]].
			</section>

	===Returns===		===Returns===

Ccw at 19:44, 10 May 2012

2012-05-10T19:44:30Z

← Older revision		Revision as of 19:44, 10 May 2012
Line 30:		Line 30:
	function beginTransfer()		function beginTransfer()
	triggerLatentServerEvent("blah", resourceRoot, myVeryLongString) -- Start latent event		triggerLatentServerEvent("blah", resourceRoot, myVeryLongString) -- Start latent event
	myHandle = getLatentEventHandles(#getLatentEventHandles()) -- Get last latent event handle		myHandle = getLatentEventHandles()[#getLatentEventHandles()] -- Get last latent event handle
	myTimer = setTimer( updateStatus, 1000, 0 ) -- Output status once a second		myTimer = setTimer( updateStatus, 1000, 0 ) -- Output status once a second
	end		end

Ccw at 02:20, 1 February 2012

2012-02-01T02:20:45Z

@@ Line 25: / Line 25: @@
 ==Example==
 <syntaxhighlight lang="lua">
---TODO
+function beginTransfer()
 </syntaxhighlight>
 ==Requirements==

Ccw at 10:36, 29 January 2012

2012-01-29T10:36:52Z

← Older revision		Revision as of 10:36, 29 January 2012
Line 19:		Line 19:
	===Returns===		===Returns===
	Returns a table with the following info or false if invalid arguments were passed:		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)		*'''tickStart:''' A number estimating 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		*'''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		*'''totalSize:''' A number representing how many bytes in total this transfer will transfer
	*'''percentComplete:''' A number between 0-100 saying how much is done		*'''percentComplete:''' A number between 0-100 saying how much is done

Ccw at 10:34, 29 January 2012

2012-01-29T10:34:45Z

← Older revision		Revision as of 10:34, 29 January 2012
Line 6:		Line 6:
	Server:		Server:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getLatentEventStatus( ~~element~~ player, int handle )		table getLatentEventStatus( player thePlayer, int handle )
	</syntaxhighlight>		</syntaxhighlight>
	Client:		Client:
Line 14:		Line 14:

	===Required Arguments===		===Required Arguments===
	*'''~~player~~:''' (Only required if called on the server) The player who is receiving the event.		*'''thePlayer:''' (Only required if called on the server) The player who is receiving the event.
	*'''~~int~~ :''' A handle previous got from [[getLatentEventHandles]].		*'''handle:''' A handle previous got from [[getLatentEventHandles]].

	===Returns===		===Returns===
	Returns a table with the following info or false if invalid arguments were passed.		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)		*'''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		*'''tickEnd:''' A number representing how many ticks until the data transfer completes
Line 28:		Line 28:
	--TODO		--TODO
	</syntaxhighlight>		</syntaxhighlight>

			==Requirements==
			{{Requirements\|1.3.0-9.03772\|1.3.0-9.03772\|}}

	==See Also==		==See Also==
	{{Event functions}}		{{Event functions}}

Ccw: Created page with "NOTOC {{Server client function}} Gets the status of one queued latent event. ==Syntax== Server: table getLatentEventStatus( element player, int handle ) ..."

2012-01-29T10:30:16Z

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> ..."

New page

__NOTOC__
{{Server client function}}
Gets the status of one queued latent event.

==Syntax==
Server:
<syntaxhighlight lang="lua">
table getLatentEventStatus( element player, int handle )
</syntaxhighlight>
Client:
<syntaxhighlight lang="lua">
table getLatentEventStatus( int handle )
</syntaxhighlight>

===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==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{Event functions}}