Difference between revisions of "Event"
From GiderosMobile
Tag: Undo |
Tag: Undo |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | <languages /> | |
| − | '''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/> | + | <!-- GIDEROSOBJ:Event --> |
| − | '''Available since:''' Gideros 2011.6<br/> | + | '''<translate>Supported platforms</translate>:''' [[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/> |
| − | '''Inherits from:''' [[Object]]<br/> | + | '''<translate>Available since</translate>:''' Gideros 2011.6<br/> |
| − | + | '''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Object|Object]]<br/> | |
| − | === Description === | + | === <translate>Description</translate> === |
| − | The objects of [[Event]] class | + | <translate><br /> |
| − | + | The objects of [[Special:MyLanguage/Event|Event]] class contains information about an event that has occurred. [[Special:MyLanguage/Event|Event]] objects<br /> | |
| − | Usually | + | are passed to event listeners when an event occurs.<br /> |
| − | + | <br /> | |
| − | Users can create their own events and dispatch | + | Usually event objects contains specific additional information about the event that has occured. For example,<br /> |
| − | + | when an [[Special:MyLanguage/Event.MOUSE_DOWN|Event.MOUSE_DOWN]] event occurs, ''x'' and ''y'' fields contain the coordinates.<br /> | |
| − | === Examples === | + | Users can create their own events and dispatch through the event mechanism.<br /></translate> |
| + | === <translate>Examples</translate> === | ||
'''Mouse down event example'''<br/> | '''Mouse down event example'''<br/> | ||
| − | <source lang="lua"> | + | <source lang="lua">function onMouseDown(event) |
| − | function onMouseDown(event) | ||
print(event.x, event.y) | print(event.x, event.y) | ||
end | end | ||
| − | mysprite:addEventListener(Event.MOUSE_DOWN, onMouseDown) | + | |
| − | </source> | + | mysprite:addEventListener(Event.MOUSE_DOWN, onMouseDown)</source> |
<br/> | <br/> | ||
| − | |||
'''User created event'''<br/> | '''User created event'''<br/> | ||
| − | <source lang="lua"> | + | <source lang="lua">local event = Event.new("myevent") |
| − | local event = Event.new("myevent") | ||
event.data1 = "12345" | event.data1 = "12345" | ||
event.data2 = "abcde" | event.data2 = "abcde" | ||
| − | mydispatcher:dispatchEvent(event) | + | mydispatcher:dispatchEvent(event)</source> |
| − | </source> | ||
| − | |||
{|- | {|- | ||
| − | |||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === Methods === | + | === <translate>Methods</translate> === |
| − | [[Event.new]] ''creates a new Event object''<br/> | + | [[Special:MyLanguage/Event.new|Event.new]] ''<translate>creates a new Event object</translate>''<br/><!-- GIDEROSMTD:Event.new(type) creates a new Event object --> |
| − | [[Event:getTarget]] ''returns the element on which the event listener was registered''<br/> | + | [[Special:MyLanguage/Event:getTarget|Event:getTarget]] ''<translate>returns the element on which the event listener was registered</translate>''<br/><!-- GIDEROSMTD:Event:getTarget() returns the element on which the event listener was registered --> |
| − | [[Event:getType]] ''returns the type of Event''<br/> | + | [[Special:MyLanguage/Event:getType|Event:getType]] ''<translate>returns the type of Event</translate>''<br/><!-- GIDEROSMTD:Event:getType() returns the type of Event --> |
| − | [[Event:stopPropagation]] ''stops the propagation of the current event in the scene tree hierarchy''<br/> | + | [[Special:MyLanguage/Event:stopPropagation|Event:stopPropagation]] ''<translate>stops the propagation of the current event in the scene tree hierarchy</translate>''<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;"| | ||
| − | + | === <translate>Events</translate> === | |
| − | === Events === | + | === <translate>Constants</translate> === |
| − | |||
| − | === Constants === | ||
| − | |||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 11:11, 4 December 2019
Supported platforms: 
Available since: Gideros 2011.6
Inherits from: Object
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 |
