RemoveEventHandler - Revision history

Damage22 at 21:41, 8 July 2010

2010-07-08T21:41:11Z

← Older revision		Revision as of 21:41, 8 July 2010
Line 39:		Line 39:
	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}
			[[ru:removeEventHandler]]

Sebassje at 17:16, 15 May 2009

2009-05-15T17:16:51Z

← Older revision		Revision as of 17:16, 15 May 2009
Line 27:		Line 27:
	if command == "starttext" then -- if player wrote /starttext		if command == "starttext" then -- if player wrote /starttext
	text = table.concat({...}," ") -- then we retrieve the text		text = table.concat({...}," ") -- then we retrieve the text
	~~func =~~ addEventHandler -- and since addEventHandler and removeEventHandler's syntax is the same, we just define the function we use later		addEventHandler("onClientRender", getRootElement(), drawText) -- and since addEventHandler and removeEventHandler's syntax is the same, we just define the function we use later
	elseif command == "stoptext" then		elseif command == "stoptext" then
	~~func =~~ removeEventHandler -- this time we use removeEventHandler		removeEventHandler("onClientRender", getRootElement(), drawText) -- this time we use removeEventHandler
	end		end
	~~func("onClientRender", getRootElement(),drawText) -- and varying on which one we chose up, we either add an event handler to show the text or remove it to stop drawing dx text.~~
	end		end
	addCommandHandler("starttext", doText) -- add two command handlers to doText function		addCommandHandler("starttext", doText) -- add two command handlers to doText function

Sebassje at 17:09, 15 May 2009

2009-05-15T17:09:35Z

← Older revision		Revision as of 17:09, 15 May 2009
Line 17:		Line 17:

	==Example==		==Example==
			<section name="Client" class="client" show="true">
	This example shows how to toggle a message on/off a screen with a command.		This example shows how to toggle a message on/off a screen with a command.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 34:		Line 35:
	addCommandHandler("starttext", doText) -- add two command handlers to doText function		addCommandHandler("starttext", doText) -- add two command handlers to doText function
	addCommandHandler("stoptext", doText)		addCommandHandler("stoptext", doText)

	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}

LordAzamath: /* Example */

2009-05-15T09:02:40Z

Example

← Older revision		Revision as of 09:02, 15 May 2009
Line 17:		Line 17:

	==Example==		==Example==
	This ~~page does not have an~~ example.		This example shows how to toggle a message on/off a screen with a command.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--add an ~~example here~~
			function drawText() -- A function to draw the text we want
			dxDrawText(text, 10,100) -- creates a dx text 10 pixels from left, 100 from top of the screen
			end
			function doText(command, ...)
			if command == "starttext" then -- if player wrote /starttext
			text = table.concat({...}," ") -- then we retrieve the text
			func = addEventHandler -- and since addEventHandler and removeEventHandler's syntax is the same, we just define the function we use later
			elseif command == "stoptext" then
			func = removeEventHandler -- this time we use removeEventHandler
			end
			func("onClientRender", getRootElement(),drawText) -- and varying on which one we chose up, we either add an event handler to show the text or remove it to stop drawing dx text.
			end
			addCommandHandler("starttext", doText) -- add two command handlers to doText function
			addCommandHandler("stoptext", doText)

	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}
	~~[[Category:Needs_Example]]~~

Talidan at 15:42, 30 August 2007

2007-08-30T15:42:14Z

← Older revision		Revision as of 15:42, 30 August 2007
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool removeEventHandler ( string eventName, element attachedTo, function ~~functionName~~ )		bool removeEventHandler ( string eventName, element attachedTo, function functionVar )
	</syntaxhighlight>		</syntaxhighlight>

Line 11:		Line 11:
	*'''eventName:''' The name of the [[event]] you want to detach the handler function from.		*'''eventName:''' The name of the [[event]] you want to detach the handler function from.
	*'''attachedTo:''' The [[element]] the handler was attached to.		*'''attachedTo:''' The [[element]] the handler was attached to.
	*'''~~functionName~~:''' The handler function that was attached.		*'''functionVar:''' The handler function that was attached.

	===Returns===		===Returns===
Line 17:		Line 17:

	==Example==		==Example==
			This page does not have an example.
			<syntaxhighlight lang="lua">
			--add an example here
			</syntaxhighlight>

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}
	[[Category:~~Incomplete~~]]		[[Category:Needs_Example]]

Jbeta at 13:27, 23 August 2007

2007-08-23T13:27:53Z

← Older revision		Revision as of 13:27, 23 August 2007
Line 1:		Line 1:
			__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~{{Needs_Checking\|Why do we have to specify what element was the handler attached to? --[[User:Jbeta\|jbeta]] 07:34, 3 June 2007 (CDT)~~
	*Because multiple elements might use the same event and function --[[User:Kevuwk\|Kevuwk]] 20:49, 22 June 2007 (CDT) }}
	~~__NOTOC__~~
	This functions removes a handler function from an [[event]], so that the function is not called anymore when the event is triggered. See [[event system]] for more information on how the event system works.		This functions removes a handler function from an [[event]], so that the function is not called anymore when the event is triggered. See [[event system]] for more information on how the event system works.

Arc at 17:26, 16 August 2007

2007-08-16T17:26:59Z

← Older revision		Revision as of 17:26, 16 August 2007
Line 1:		Line 1:
			{{Server client function}}
	{{Needs_Checking\|Why do we have to specify what element was the handler attached to? --[[User:Jbeta\|jbeta]] 07:34, 3 June 2007 (CDT)		{{Needs_Checking\|Why do we have to specify what element was the handler attached to? --[[User:Jbeta\|jbeta]] 07:34, 3 June 2007 (CDT)
	*Because multiple elements might use the same event and function --[[User:Kevuwk\|Kevuwk]] 20:49, 22 June 2007 (CDT) }}		*Because multiple elements might use the same event and function --[[User:Kevuwk\|Kevuwk]] 20:49, 22 June 2007 (CDT) }}
Line 6:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool removeEventHandler ( string eventName, element attachedTo, ~~string~~ functionName )		bool removeEventHandler ( string eventName, element attachedTo, function functionName )
	</syntaxhighlight>		</syntaxhighlight>

Line 12:		Line 13:
	*'''eventName:''' The name of the [[event]] you want to detach the handler function from.		*'''eventName:''' The name of the [[event]] you want to detach the handler function from.
	*'''attachedTo:''' The [[element]] the handler was attached to.		*'''attachedTo:''' The [[element]] the handler was attached to.
	*'''functionName:''' The ~~name of the~~ handler function that was attached.		*'''functionName:''' The handler function that was attached.

	===Returns===		===Returns===
Line 18:		Line 19:

	==Example==		==Example==
	~~This example...~~

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}
	[[Category:Incomplete]]		[[Category:Incomplete]]

Kevuwk at 01:49, 23 June 2007

2007-06-23T01:49:30Z

← Older revision		Revision as of 01:49, 23 June 2007
Line 1:		Line 1:
	{{Needs_Checking\|Why do we have to specify what element was the handler attached to? --[[User:Jbeta\|jbeta]] 07:34, 3 June 2007 (CDT)}}		{{Needs_Checking\|Why do we have to specify what element was the handler attached to? --[[User:Jbeta\|jbeta]] 07:34, 3 June 2007 (CDT)
			*Because multiple elements might use the same event and function --[[User:Kevuwk\|Kevuwk]] 20:49, 22 June 2007 (CDT) }}
	__NOTOC__		__NOTOC__
	This functions removes a handler function from an [[event]], so that the function is not called anymore when the event is triggered. See [[event system]] for more information on how the event system works.		This functions removes a handler function from an [[event]], so that the function is not called anymore when the event is triggered. See [[event system]] for more information on how the event system works.

Jbeta at 12:34, 3 June 2007

2007-06-03T12:34:50Z

← Older revision		Revision as of 12:34, 3 June 2007
Line 1:		Line 1:
			{{Needs_Checking\|Why do we have to specify what element was the handler attached to? --[[User:Jbeta\|jbeta]] 07:34, 3 June 2007 (CDT)}}
	__NOTOC__		__NOTOC__
	This ~~fake~~ function is for ~~use with blah & blah and does blahblahblabhalbhl~~		This functions removes a handler function from an [[event]], so that the function is not called anymore when the event is triggered. See [[event system]] for more information on how the event system works.

	==Syntax==		==Syntax==
Line 8:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''~~argumentName~~:''' ~~description~~		*'''eventName:''' The name of the [[event]] you want to detach the handler function from.
			*'''attachedTo:''' The [[element]] the handler was attached to.
	~~===Optional Arguments===~~		*'''functionName:''' The name of the handler function that was attached.
	~~{{OptionalArg}}~~
	*'''~~argumentName2~~:''' ~~description~~
	*'''~~argumentName3~~:''' ~~description~~

	===Returns===		===Returns===
	Returns ''true'' if ~~blah,~~ ''false'' ~~otherwise~~.		Returns ''true'' if the event handler was removed successfully. Returns ''false'' if the specified event handler could not be found or invalid parameters were passed.

	==Example==		==Example==
	This example ~~does~~...		This example...
	~~<syntaxhighlight lang="lua">~~
	~~--This line does...~~
	~~blabhalbalhb --abababa~~
	~~--This line does this...~~
	~~mooo~~
	~~</syntaxhighlight>~~

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}
			[[Category:Incomplete]]

Ransom at 01:21, 19 November 2006

2006-11-19T01:21:47Z

← Older revision		Revision as of 01:21, 19 November 2006
Line 1:		Line 1:
	~~[[Category:Incomplete]]~~

	__NOTOC__		__NOTOC__
	This fake function is for use with blah & blah and does blahblahblabhalbhl		This fake function is for use with blah & blah and does blahblahblabhalbhl