WasEventCancelled - Revision history

EOFIK: Edited language change

2022-06-08T11:51:56Z

Edited language change

← Older revision		Revision as of 11:51, 8 June 2022
Line 34:		Line 34:
	==See Also==		==See Also==
	{{Event functions}}		{{Event functions}}

			[[ru:wasEventCancelled]]

Ccw at 15:42, 2 October 2012

2012-10-02T15:42:15Z

← Older revision		Revision as of 15:42, 2 October 2012
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}

	This function checks ~~whether or not ''~~the ~~currently active~~ event~~'' has been canceled~~. This is mainly useful for custom events created by scripts.		This function checks if the last completed event was cancelled. This is mainly useful for custom events created by scripts.

	Events can be cancelled using [[cancelEvent]], this indicates that the resource ~~that~~ triggered the event should do whatever it can to reverse any changes made by whatever caused the event. See [[triggerEvent]] for a more detailed explanation of this.		Events can be cancelled using [[cancelEvent]], this indicates that the resource which triggered the event should do whatever it can to reverse any changes made by whatever caused the event. See [[triggerEvent]] for a more detailed explanation of this.

	==Syntax==		==Syntax==
Line 12:		Line 12:

	===Returns===		===Returns===
	Returns ''true'' if the event was ~~canceled~~, ''false'' if it wasn't or doesn't exist.		Returns ''true'' if the event was cancelled, ''false'' if it wasn't or doesn't exist.

	==Example==		==Example==
Line 24:		Line 24:
	triggerEvent ( "onFlagPickup", source, thePlayer ) -- trigger our onFlagPickup event		triggerEvent ( "onFlagPickup", source, thePlayer ) -- trigger our onFlagPickup event

	if ( not wasEventCancelled() ) then -- if ~~the handler~~ for ~~the event~~ didn't cancel it then		if ( not wasEventCancelled() ) then -- if handlers for 'onFlagPickup' didn't cancel it then
	setElementData ( thePlayer, "hasFlag", true ) -- set that the player picked up the flag		setElementData ( thePlayer, "hasFlag", true ) -- set that the player picked up the flag
	end		end

X86dev at 20:37, 22 January 2012

2012-01-22T20:37:25Z

← Older revision		Revision as of 20:37, 22 January 2012
Line 17:		Line 17:
	This example implements a custom event ''onFlagPickup'' that would be triggered if an ''onMarkerHit'' event was triggered on a marker whose parent was a ''flag'' element. If the event isn't canceled then an element data value is set on the player.		This example implements a custom event ''onFlagPickup'' that would be triggered if an ''onMarkerHit'' event was triggered on a marker whose parent was a ''flag'' element. If the event isn't canceled then an element data value is set on the player.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEvent ( "onFlagPickup" )		addEvent ( "onFlagPickup", true )

	function flagHitcheck ( thePlayer )		function flagHitcheck ( thePlayer )

X86dev at 20:37, 22 January 2012

2012-01-22T20:37:03Z

← Older revision		Revision as of 20:37, 22 January 2012
Line 17:		Line 17:
	This example implements a custom event ''onFlagPickup'' that would be triggered if an ''onMarkerHit'' event was triggered on a marker whose parent was a ''flag'' element. If the event isn't canceled then an element data value is set on the player.		This example implements a custom event ''onFlagPickup'' that would be triggered if an ''onMarkerHit'' event was triggered on a marker whose parent was a ''flag'' element. If the event isn't canceled then an element data value is set on the player.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEvent ( "onFlagPickup~~", "thePlayer~~" )		addEvent ( "onFlagPickup" )

	function flagHitcheck ( thePlayer )		function flagHitcheck ( thePlayer )

EAi at 12:51, 12 March 2010

2010-03-12T12:51:09Z

← Older revision		Revision as of 12:51, 12 March 2010
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~{{Deprecated}}~~
	This function checks whether or not ''the currently active event'' has been canceled. This is mainly useful for custom events created by scripts.		This function checks whether or not ''the currently active event'' has been canceled. This is mainly useful for custom events created by scripts.

ChrML at 11:06, 17 January 2008

2008-01-17T11:06:09Z

← Older revision		Revision as of 11:06, 17 January 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
			{{Deprecated}}
	This function checks whether or not ''the currently active event'' has been canceled. This is mainly useful for custom events created by scripts.		This function checks whether or not ''the currently active event'' has been canceled. This is mainly useful for custom events created by scripts.

EAi at 23:13, 6 December 2007

2007-12-06T23:13:18Z

← Older revision		Revision as of 23:13, 6 December 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function checks whether or not the currently active event ~~was~~ canceled. This is mainly useful for custom events created by scripts.		This function checks whether or not ''the currently active event'' has been canceled. This is mainly useful for custom events created by scripts.

	Events can be cancelled using [[cancelEvent]], this indicates that the resource that triggered the event should do whatever it can to reverse any changes made by whatever caused the event. See [[triggerEvent]] for a more detailed explanation of this.		Events can be cancelled using [[cancelEvent]], this indicates that the resource that triggered the event should do whatever it can to reverse any changes made by whatever caused the event. See [[triggerEvent]] for a more detailed explanation of this.

EAi at 23:11, 6 December 2007

2007-12-06T23:11:57Z

← Older revision		Revision as of 23:11, 6 December 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function checks whether or not the currently active event was canceled. This is mainly useful for custom events created by scripts. Events can be cancelled using [[cancelEvent]], this indicates that the resource that triggered the event should do whatever it can to reverse any changes made by whatever caused the event. See [[triggerEvent]] for a more detailed explanation of this.		This function checks whether or not the currently active event was canceled. This is mainly useful for custom events created by scripts.

			Events can be cancelled using [[cancelEvent]], this indicates that the resource that triggered the event should do whatever it can to reverse any changes made by whatever caused the event. See [[triggerEvent]] for a more detailed explanation of this.

	==Syntax==		==Syntax==

EAi at 23:11, 6 December 2007

2007-12-06T23:11:08Z

← Older revision		Revision as of 23:11, 6 December 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function checks whether or not the currently active event was canceled. This is mainly useful for custom events created by scripts.		This function checks whether or not the currently active event was canceled. This is mainly useful for custom events created by scripts. Events can be cancelled using [[cancelEvent]], this indicates that the resource that triggered the event should do whatever it can to reverse any changes made by whatever caused the event. See [[triggerEvent]] for a more detailed explanation of this.

	==Syntax==		==Syntax==

Talidan at 16:30, 2 December 2007

2007-12-02T16:30:59Z

← Older revision		Revision as of 16:30, 2 December 2007
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~wasEventCanceled~~ ( )		bool wasEventCancelled ( )
	</syntaxhighlight>		</syntaxhighlight>

Line 21:		Line 21:
	triggerEvent ( "onFlagPickup", source, thePlayer ) -- trigger our onFlagPickup event		triggerEvent ( "onFlagPickup", source, thePlayer ) -- trigger our onFlagPickup event

	if ( not ~~wasEventCanceled~~() ) then -- if the handler for the event didn't cancel it then		if ( not wasEventCancelled() ) then -- if the handler for the event didn't cancel it then
	setElementData ( thePlayer, "hasFlag", true ) -- set that the player picked up the flag		setElementData ( thePlayer, "hasFlag", true ) -- set that the player picked up the flag
	end		end