Difference between revisions of "Event"
m |
(added a note) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- GIDEROSOBJ:Event --> | <!-- GIDEROSOBJ:Event --> | ||
| − | ''' | + | '''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/> |
| − | ''' | + | '''Available since:''' Gideros 2011.6<br/> |
| − | ''' | + | '''Inherits from:''' [[Object]]<br/> |
=== Description === | === Description === | ||
| Line 29: | Line 29: | ||
mydispatcher:dispatchEvent(event) | mydispatcher:dispatchEvent(event) | ||
</source> | </source> | ||
| + | |||
| + | === Note === | ||
| + | Please note that most events happen on the '''Sprite''' class: [[Sprite]] | ||
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === | + | === Methods === |
| − | [[ | + | [[Event.new]] ''creates a new Event object''<br/><!-- GIDEROSMTD:Event.new(type) creates a new Event object --> |
| − | <!-- 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 --> |
| − | <!-- 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: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 --> |
| − | <!-- GIDEROSMTD:Event:getType() returns the type of Event --> | ||
| − | [[ | ||
| − | <!-- 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;"| | ||
| − | === | + | === Events === |
| − | === | + | === Constants === |
|} | |} | ||
{{GIDEROS IMPORTANT LINKS}} | {{GIDEROS IMPORTANT LINKS}} | ||
Revision as of 02:02, 22 November 2020
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 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)
Note
Please note that most events happen on the Sprite class: Sprite
MethodsEvent.new creates a new Event object Event:getTarget returns the element on which the event listener was registered |
EventsConstants |
