func_event_runhooks.rst 662 B

123456789101112131415161718192021222324252627282930313233343536373839
  1. .. _func_event_runhooks:
  2. ========
  3. RunHooks
  4. ========
  5. RunHooks -
  6. Description
  7. ===========
  8. .. code-block:: blitzmax
  9. RunHooks:Object( id,data:Object )
  10. Run hook functions
  11. #RunHooks runs all hook functions that have been added for the specified hook @id.
  12. The first hook function is called with the provided @data object. The object returned by
  13. this function is then passed as the @data parameter to the next hook function and so on.
  14. Therefore, hook functions should generally return the @data parameter when finished.
  15. Parameters
  16. ==========
  17. Return Values
  18. =============
  19. The data produced by the last hook function
  20. Examples
  21. ========
  22. See Also
  23. ========