CancelLatentEvent: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{Needs_Example}} | |||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} |
Revision as of 16:44, 19 August 2015
Script Example Missing Function CancelLatentEvent needs a script example, help out by writing one. | |
Before submitting check out Editing Guidelines Script Examples. |
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
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
Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled