WasEventCancelled

From Multi Theft Auto: Wiki
Revision as of 16:29, 2 December 2007 by Talidan (talk | contribs) (New page: __NOTOC__ {{Server client function}} This function checks whether or not the currently active event was canceled. This is mainly useful for custom events created by scripts. ==Syntax== <...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function checks whether or not the currently active event was canceled. This is mainly useful for custom events created by scripts.

Syntax

bool wasEventCanceled ( )   

Returns

Returns true if the event was canceled, false if it wasn't or doesn't exist.

Example

This example implements a custom event onFlagPickup that would be triggered if an onMarkerHit event was triggered on a marker whose parent was a flag element. If the event isn't canceled then an element data value is set on the player.

addEvent ( "onFlagPickup", "thePlayer" )

function flagHitcheck ( thePlayer )
    parentElement = getElementParent ( source ) -- get the parent of the marker
    if ( getElementType ( parentElement ) == "flag" ) then -- if it was a flag element then
        triggerEvent ( "onFlagPickup", source, thePlayer ) -- trigger our onFlagPickup event
        
        if ( not wasEventCanceled() ) then -- if the handler for the event didn't cancel it then
            setElementData ( thePlayer, "hasFlag", true ) -- set that the player picked up the flag
        end
    end
end
addEventHandler ( "onMarkerHit", getRootElement(), flagHitCheck )

See Also