CancelLatentEvent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} Stops a latent event from completing ==Syntax== Server: <syntaxhighlight lang="lua"> table cancelLatentEvent( player thePlayer, int handle ) </syntaxhighlight> Client: ...")
 
Line 4: Line 4:


==Syntax==
==Syntax==
Server:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table cancelLatentEvent( player thePlayer, int handle )
table cancelLatentEvent( 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 cancelLatentEvent( int handle )
table cancelLatentEvent( 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===

Revision as of 06:04, 4 July 2012

Stops a latent event from completing

Syntax

Click to collapse [-]
Server
table cancelLatentEvent( player thePlayer, int handle )

Required Arguments

  • thePlayer: The player who is receiving the event.
  • handle: A handle previous got from getLatentEventHandles.
Click to collapse [-]
Client
table cancelLatentEvent( int handle )

Required Arguments

Returns

Returns a true if the latent event was successfully cancelled, or false if it was not

Example

--TODO

Requirements

This template will be deleted.

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/CancelLatentEvent?oldid=31765"