Difference between revisions of "TriggerEvent"

From Multi Theft Auto: Wiki
Jump to: navigation, search
Line 14: Line 14:
 
===Optional Arguments===  
 
===Optional Arguments===  
 
{{OptionalArg}}  
 
{{OptionalArg}}  
*'''argument1:''' The arguments that the event handler expects should be added after the ''baseElement'' variable.
+
*'''argument1:''' The first argument that the event handler expects should be added after the ''baseElement'' variable.
 +
**''NOTE:'' This function can have more than one of these arguments specified, once for each argument the event handler is expecting.
  
 
===Returns===
 
===Returns===

Revision as of 02:41, 16 August 2006


Dialog-information.png This article needs checking.

Reason(s): Confirm return information

This function will trigger a named event on a specific element in the element tree. See event system for more information on how the event system works.

Syntax

bool triggerEvent ( string eventName, element baseElement, [ var argument1, ... ] )    

Required Arguments

  • eventName: The name of the event you wish to trigger
  • baseElement: The element you wish to trigger the event on. See event system for information on how this works.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • argument1: The first argument that the event handler expects should be added after the baseElement variable.
    • NOTE: This function can have more than one of these arguments specified, once for each argument the event handler is expecting.

Returns

Returns true if the event was triggered successfully. This may involve calling no handlers (if none have been attached to the event), it will still be considered successful. Returns false if the arguments are invalid or the event could not be found.

Example

If you define a new custom event as follows:

-- Get the root map element
rootElement = getRootElement ()

-- Add a new event called onSpecialEvent
addEvent ( "onSpecialEvent", "text" )

-- Add an event handler
addEventHandler ( "onSpecialEvent", rootElement, "specialEventHandler" )
-- Define our handler function
function specialEventHandler ( text )
	outputChatBox ( text )
end

You can then trigger this event later on using:

	triggerEvent ( "onSpecialEvent", rootElement, "test" )

See Also