Functions Documentation
View Function Edit Function
Name objFireOverlayEvent
Syntax (objFireOverlayEvent obj overlayID event) -> result
Argument List sObj: spaceOjbect the overlay is on
overlayID: the overlay to access
event: the event to trigger, string(?)
Returns result: return value of event code
Category overlay
Description Executes code from the <Events> section of the OverlayType related to the chosen overlay.
Example From CorporateHierarchy.xml
; Remove any overlays that shouldn't be there (e.g., pteravores)
(enum (objGetOverlays gPlayerShip) theOverlay
(objFireOverlayEvent gPlayerShip theOverlay "OnInsuranceClaim")
)
From EncountersVol01.xml
<OnInsuranceClaim>
; Insurance cleans up pteravores
(objRemoveOverlay gSource aOverlayID)
</OnInsuranceClaim>
Comment