RemoveEventHandler: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
mNo edit summary
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
__NOTOC__  
__NOTOC__  
This fake function is for use with blah & blah and does blahblahblabhalbhl
{{Server client function}}
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==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
syntax here
bool removeEventHandler ( string eventName, element attachedTo, function functionVar )
</syntaxhighlight>  
</syntaxhighlight>  


===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===
*'''functionVar:''' 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...
<section name="Client" class="client" show="true">
This example shows how to toggle a message on/off a screen with a command.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
 
blabhalbalhb --abababa
function drawText() -- A function to draw the text we want
--This line does this...
dxDrawText(text, 10,100) -- creates a dx text 10 pixels from left, 100 from top of the screen
mooo
end
function doText(command, ...)
if command == "starttext" then -- if player wrote /starttext
text = table.concat({...}," ") -- then we retrieve the text
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
removeEventHandler("onClientRender", getRootElement(), drawText) -- this time we use removeEventHandler
end
end
addCommandHandler("starttext", doText) -- add two command handlers to doText function
addCommandHandler("stoptext", doText)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Event_functions}}
[[ru:removeEventHandler]]

Latest revision as of 21:41, 8 July 2010

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

bool removeEventHandler ( string eventName, element attachedTo, function functionVar ) 

Required Arguments

  • eventName: The name of the event you want to detach the handler function from.
  • attachedTo: The element the handler was attached to.
  • functionVar: The handler function that was attached.

Returns

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

Click to collapse [-]
Client

This example shows how to toggle a message on/off a screen with a command.


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
		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
		removeEventHandler("onClientRender", getRootElement(), drawText) 	-- this time we use removeEventHandler
	end
end
addCommandHandler("starttext", doText) -- add two command handlers to doText function
addCommandHandler("stoptext", doText)

See Also