CancelLatentEvent: Difference between revisions
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=== | ||
*'''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 [-]
Servertable 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 [-]
Clienttable cancelLatentEvent( int handle )
Required Arguments
- 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 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
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getCancelReason
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerClientEvent
- triggerLatentClientEvent
- wasEventCancelled