CancelLatentEvent: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 6: | Line 6: | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool cancelLatentEvent( player thePlayer, int handle ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 15: | Line 15: | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool cancelLatentEvent( int handle ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 13:50, 4 November 2012
Stops a latent event from completing
Syntax
Click to collapse [-]
Serverbool 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 [-]
Clientbool 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
This template will be deleted.
See Also
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled