Difference between revisions of "Event"
(added a note) |
|||
| Line 8: | Line 8: | ||
The objects of '''Event''' class contain information about an event that has occurred. '''Event''' objects are passed to event listeners when an event occurs. | The objects of '''Event''' class contain information about an event that has occurred. '''Event''' objects are passed to event listeners when an event occurs. | ||
| − | Usually event objects | + | Usually event objects contain specific additional information about the event that has occured. For example, when an [[Event.MOUSE_DOWN]] event occurs, ''x'' and ''y'' fields contain the coordinates. |
Users can create their own events and dispatch through the event mechanism. | Users can create their own events and dispatch through the event mechanism. | ||
| Line 31: | Line 31: | ||
=== Note === | === Note === | ||
| − | Please note that most events happen on the '''Sprite''' class | + | Please note that most events happen on the '''[[Sprite]]''' class. |
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== Methods === | === Methods === | ||
| − | [[Event.new]] ''creates a new Event object''<br/><!-- GIDEROSMTD:Event.new(type) creates a new Event object --> | + | [[Event.new]] ''creates a new Event object''<br/><!--GIDEROSMTD:Event.new(type) creates a new Event object--> |
| − | [[Event:getTarget]] ''returns the element on which the event listener was registered''<br/><!-- GIDEROSMTD:Event:getTarget() returns the element on which the event listener was registered --> | + | [[Event:getTarget]] ''returns the element on which the event listener was registered''<br/><!--GIDEROSMTD:Event:getTarget() returns the element on which the event listener was registered--> |
| − | [[Event:getType]] ''returns the type of Event''<br/><!-- GIDEROSMTD:Event:getType() returns the type of Event --> | + | [[Event:getType]] ''returns the type of Event''<br/><!--GIDEROSMTD:Event:getType() returns the type of Event--> |
| − | [[Event:stopPropagation]] ''stops the propagation of the current event in the scene tree hierarchy''<br/><!-- GIDEROSMTD:Event:stopPropagation() stops the propagation of the current event in the scene tree hierarchy --> | + | [[Event:stopPropagation]] ''stops the propagation of the current event in the scene tree hierarchy''<br/><!--GIDEROSMTD:Event:stopPropagation() stops the propagation of the current event in the scene tree hierarchy--> |
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
Revision as of 11:09, 13 November 2022
Supported platforms: 
Available since: Gideros 2011.6
Inherits from: Object
Description
The objects of Event class contain information about an event that has occurred. Event objects are passed to event listeners when an event occurs.
Usually event objects contain specific additional information about the event that has occured. For example, when an Event.MOUSE_DOWN event occurs, x and y fields contain the coordinates.
Users can create their own events and dispatch through the event mechanism.
Examples
Mouse down event example
function onMouseDown(event)
print(event.x, event.y)
end
mysprite:addEventListener(Event.MOUSE_DOWN, onMouseDown)
User created event
local event = Event.new("myevent")
event.data1 = "12345"
event.data2 = "abcde"
mydispatcher:dispatchEvent(event)
Note
Please note that most events happen on the Sprite class.
MethodsEvent.new creates a new Event object Event:getTarget returns the element on which the event listener was registered |
EventsConstants |
