modding:function:objfireoverlayevent
Discuss this page on this pages TalkPage
objFireOverlayEvent
| Syntax | (objFireOverlayEvent obj overlayID event [data]) |
|---|---|
| Arguments | obj: The object to fire the event |
| overlayID: ID of the overlay to fire the event on | |
| event: The named event to fire on the overlay | |
| [data]: (optional) arbitrary data to pass on to the event | |
| Returns | Result of event |
| Category | spaceObject functions |
| Description | Immediately fires an event on an overlay from an object. |
Example
(objFireOverlayEvent gPlayerShip theOverlay 'Success)
Fires the named event <Success> on the overlay. Useful for cases where certain actions on an overlay should have events attached, like removing the overlay.
Return to Space Object functions list
Return to functions list
modding/function/objfireoverlayevent.txt · Last modified: 2017/02/03 23:57 by xephyr