CancelLatentEvent

From Multi Theft Auto: Wiki
Revision as of 10:34, 29 January 2012 by Ccw (talk | contribs) (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: ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Stops a latent event from completing

Syntax

Server:

table cancelLatentEvent( player thePlayer, int handle )

Client:

table cancelLatentEvent( 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 true if the latent event was successfully cancelled, or false if it was not

Example

--TODO

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

See Also