Reference 〉 Function


Runs the user-defined event function to determine whether the event is triggered and records the model state. If Event.repeat==False, this function will return False so long as Event.trigger returns False, True the first time Event.trigger returns True, and False thereafter. If Event.repeat==True, the function returns True whenever Event.trigger returns True.

WARNING: This is an internal function. Its use in user code is not recommended or supported, and its signature can change in future updates without warning. Use one of the suggested functions above instead, if applicable.


  • model Helipad, required

    The model object.

Return Value bool

Whether the event criterion is satisfied this period.

Notes and Examples

  1. Contribute a Note

    Your email address will not be published. Required fields are marked *

    You may use limited HTML for formatting. Please embed blocks of code in <pre><code> </code></pre> tags.