Transcendence Community Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

Discuss this page on this pages [[objFireOverlayEvent Talk Page|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 ===

<code lisp>(objFireOverlayEvent gPlayerShip theOverlay 'Success)
 </code>

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 [[modding:function:spaceObject_functions|Space Object functions]] list

Return to [[modding:functions:]] list