Difference between revisions of "Event"
| Line 4: | Line 4: | ||
=== Description === | === Description === | ||
<translate><br /> | <translate><br /> | ||
| − | The objects of [[Event]] class contains information about an event that has occurred. [[Event]] objects<br /> | + | The objects of [[Special:MyLanguage/Event|Event]] class contains information about an event that has occurred. [[Special:MyLanguage/Event|Event]] objects<br /> |
are passed to event listeners when an event occurs.<br /> | are passed to event listeners when an event occurs.<br /> | ||
<br /> | <br /> | ||
Usually event objects contains specific additional information about the event that has occured. For example,<br /> | Usually event objects contains specific additional information about the event that has occured. For example,<br /> | ||
| − | when an [[Event.MOUSE_DOWN]] event occurs, [[x]] and [[y]] fields contain the coordinates.<br /> | + | when an [[Special:MyLanguage/Event.MOUSE_DOWN|Event.MOUSE_DOWN]] event occurs, [[Special:MyLanguage/x|x]] and [[Special:MyLanguage/y|y]] fields contain the coordinates.<br /> |
Users can create their own events and dispatch through the event mechanism.<br /></translate> | Users can create their own events and dispatch through the event mechanism.<br /></translate> | ||
=== Examples === | === Examples === | ||
| Line 24: | Line 24: | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== Methods === | === Methods === | ||
| − | [[Event.new]] ''<translate>creates a new Event object</translate>''<br/> | + | [[Special:MyLanguage/Event.new|Event.new]] ''<translate>creates a new Event object</translate>''<br/> |
| − | [[Event:getTarget]] ''<translate>returns the element on which the event listener was registered</translate>''<br/> | + | [[Special:MyLanguage/Event:getTarget|Event:getTarget]] ''<translate>returns the element on which the event listener was registered</translate>''<br/> |
| − | [[Event:getType]] ''<translate>returns the type of Event</translate>''<br/> | + | [[Special:MyLanguage/Event:getType|Event:getType]] ''<translate>returns the type of Event</translate>''<br/> |
| − | [[Event:stopPropagation]] ''<translate>stops the propagation of the current event in the scene tree hierarchy</translate>''<br/> | + | [[Special:MyLanguage/Event:stopPropagation|Event:stopPropagation]] ''<translate>stops the propagation of the current event in the scene tree hierarchy</translate>''<br/> |
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== Events === | === Events === | ||
=== Constants === | === Constants === | ||
|} | |} | ||
Revision as of 16:35, 23 August 2018
Supported platforms: android, ios, mac, pc
Available since: Gideros 2011.6
Description
The objects of Event class contains information about an event that has occurred. Event objects
are passed to event listeners when an event occurs.
Usually event objects contains 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)
MethodsEvent.new creates a new Event object |
EventsConstants |
